----------------------------------------------------------- This is an automatically generated e-mail. To reply, visit: https://reviews.apache.org/r/38635/#review100290 -----------------------------------------------------------
Just some feedback on doxygen usage; trying to avoid comment bloat and redundancy. Looking over our doxygen comment style, it looks like we may want to altogether avoid the use of @param, @return in favor just converting our existing `//` paragraph style comments into `/** */` comments so that they get picked up by doxygen. That probably would have been a better first step for doxygen usage in retrospect IMHO. src/linux/systemd.hpp (lines 52 - 65) <https://reviews.apache.org/r/38635/#comment157448> Ditto w.r.t. redundant documentation across top and @return lines. src/linux/systemd.hpp (lines 79 - 83) <https://reviews.apache.org/r/38635/#comment157447> These lines look redundant, can you remove the @return? src/linux/systemd.hpp (line 93) <https://reviews.apache.org/r/38635/#comment157446> Do we really need to say this? This is standard for Try. src/linux/systemd.hpp (lines 98 - 106) <https://reviews.apache.org/r/38635/#comment157445> This kind of comment only tells me 1 thing about the method, namely that it the way it starts the slice is through "systemctl start <name>". Everything else I can infer from the function signature. Is it worth bloating the source with 9 lines of doxygen like this? Or can we do it in 1 line? ``` /** Starts the slice with the given name (via 'systemctl start <name>'). */ ``` Also, we've been using two asterisks on the first line for it to be considered doxygen. - Ben Mahler On Sept. 23, 2015, 8:34 p.m., Joris Van Remoortere wrote: > > ----------------------------------------------------------- > This is an automatically generated e-mail. To reply, visit: > https://reviews.apache.org/r/38635/ > ----------------------------------------------------------- > > (Updated Sept. 23, 2015, 8:34 p.m.) > > > Review request for mesos, Benjamin Hindman, Artem Harutyunyan, Jie Yu, Niklas > Nielsen, Thomas Rampelberg, and Timothy Chen. > > > Bugs: MESOS-3425 > https://issues.apache.org/jira/browse/MESOS-3425 > > > Repository: mesos > > > Description > ------- > > See summary. > > > Diffs > ----- > > src/linux/systemd.hpp PRE-CREATION > src/linux/systemd.cpp PRE-CREATION > src/slave/containerizer/linux_launcher.hpp > f6112c98ffcc46ebcaf5581e821d5481d2f6b494 > src/slave/containerizer/linux_launcher.cpp > 459af1b98ba577863d88d521f3ba8792959f42b4 > src/slave/flags.hpp e31a4183170c3442ac4a15365c229391e7e91480 > src/slave/flags.cpp add4196dfd06c0f602ff5ebd39960dc05c4cd11f > > Diff: https://reviews.apache.org/r/38635/diff/ > > > Testing > ------- > > > Thanks, > > Joris Van Remoortere > >
