> On Sept. 28, 2017, 5:54 p.m., Benjamin Bannier wrote: > > include/mesos/authentication/http/authenticatee.hpp > > Lines 48-49 (patched) > > <https://reviews.apache.org/r/62587/diff/1/?file=1835964#file1835964line48> > > > > Since our Doxygen setup uses `JAVADOC_AUTOBRIEF` which makes the first > > paragraph a brief description, can we add one here?, e.g., > > > > Create a HTTP request for authentication. > > Till Toenshoff wrote: > Our docs/doxygen-style-guide.md does not mention this tag, hence I am not > sure our site renderer swallows that properly. Could you please enhance it > that way?
Looking at the Doxygen style guide, it seems we already make the preferred comment format explicit. We currently have https://github.com/apache/mesos/blob/32ea75b8426fb3972680a397dc3a05ff266d166d/docs/doxygen-style-guide.md#L22-L53 which contains both an example and a link to the exact format of Javadoc comment blocks, https://en.wikipedia.org/wiki/Javadoc#Structure_of_a_Javadoc_comment. I am not sure that adding more information here would make this any clearer. - Benjamin ----------------------------------------------------------- This is an automatically generated e-mail. To reply, visit: https://reviews.apache.org/r/62587/#review186390 ----------------------------------------------------------- On Oct. 2, 2017, 8:55 p.m., Till Toenshoff wrote: > > ----------------------------------------------------------- > This is an automatically generated e-mail. To reply, visit: > https://reviews.apache.org/r/62587/ > ----------------------------------------------------------- > > (Updated Oct. 2, 2017, 8:55 p.m.) > > > Review request for mesos, Armand Grillet, Benjamin Bannier, Greg Mann, and > Kapil Arya. > > > Bugs: MESOS-8016 > https://issues.apache.org/jira/browse/MESOS-8016 > > > Repository: mesos > > > Description > ------- > > Added HTTP authenticatee interface definition. > > > Diffs > ----- > > include/mesos/authentication/http/authenticatee.hpp PRE-CREATION > src/Makefile.am 93ed2bf55447e3e470d9bea8a0b61ce78aad1900 > > > Diff: https://reviews.apache.org/r/62587/diff/4/ > > > Testing > ------- > > Integration test in external project. Further tests upcoming. > > > Thanks, > > Till Toenshoff > >
