Re: Review Request 36193: Improved Doxygen-Styleguide.
--- This is an automatically generated e-mail. To reply, visit: https://reviews.apache.org/r/36193/#review91086 --- Ship it! Ship It! - Bernd Mathiske On July 6, 2015, 2:01 a.m., Joerg Schad wrote: --- This is an automatically generated e-mail. To reply, visit: https://reviews.apache.org/r/36193/ --- (Updated July 6, 2015, 2:01 a.m.) Review request for mesos, Benjamin Hindman, Bernd Mathiske, and Joseph Wu. Repository: mesos Description --- Improved Doxygen-Styleguide for clarifying discussions arising from https://reviews.apache.org/r/36141/. Diffs - docs/mesos-doxygen-style-guide.md 72156c72fc40f72740e57d47d0436c60f6d05bd7 Diff: https://reviews.apache.org/r/36193/diff/ Testing --- Checked rendered markdown. Thanks, Joerg Schad
Review Request 36193: Improved Doxygen-Styleguide.
--- This is an automatically generated e-mail. To reply, visit: https://reviews.apache.org/r/36193/ --- Review request for mesos, Benjamin Hindman, Bernd Mathiske, and Joseph Wu. Repository: mesos Description --- Improved Doxygen-Styleguide for clarifying discussions arising from https://reviews.apache.org/r/36141/. Diffs - docs/mesos-doxygen-style-guide.md 72156c72fc40f72740e57d47d0436c60f6d05bd7 Diff: https://reviews.apache.org/r/36193/diff/ Testing --- Checked rendered markdown. Thanks, Joerg Schad
Re: Review Request 36193: Improved Doxygen-Styleguide.
On July 6, 2015, 11:39 a.m., Joseph Wu wrote: docs/mesos-doxygen-style-guide.md, line 102 https://reviews.apache.org/r/36193/diff/1/?file=999588#file999588line102 This isn't part of the diff, but should this `@note` tag be replaced with a `**NOTE:**`? Joerg Schad wrote: Good catch! But not part of this review, do you want to create another patch for this? Patch here: https://reviews.apache.org/r/36218/ - Joseph --- This is an automatically generated e-mail. To reply, visit: https://reviews.apache.org/r/36193/#review90525 --- On July 6, 2015, 2:01 a.m., Joerg Schad wrote: --- This is an automatically generated e-mail. To reply, visit: https://reviews.apache.org/r/36193/ --- (Updated July 6, 2015, 2:01 a.m.) Review request for mesos, Benjamin Hindman, Bernd Mathiske, and Joseph Wu. Repository: mesos Description --- Improved Doxygen-Styleguide for clarifying discussions arising from https://reviews.apache.org/r/36141/. Diffs - docs/mesos-doxygen-style-guide.md 72156c72fc40f72740e57d47d0436c60f6d05bd7 Diff: https://reviews.apache.org/r/36193/diff/ Testing --- Checked rendered markdown. Thanks, Joerg Schad
Re: Review Request 36193: Improved Doxygen-Styleguide.
On July 6, 2015, 6:06 p.m., Joseph Wu wrote: Can you comment on the use of the `@copydoc` tag? I used it in the associated review (36141), but it isn't mentioned in the Doxygen style guide. I am somewhat hesitant about us trying to whitelist *everything* that is allowed. I much prefer Google's approach of if it's not forbidden, and is not obviously wrong, it should be allowed The risk is to having then to maintain huge (and expanding) list of allowed stuff, and people having to memorize them - ideally, one should have the general guidelines, as the ones here; a set of blacklisted features (brief and automated checks); and then a general freedom to use whatever is not forbidden. Trying to codify every little thing tends to stifle creativity and is not something we should strive for, IMHO. - Marco --- This is an automatically generated e-mail. To reply, visit: https://reviews.apache.org/r/36193/#review90515 --- On July 6, 2015, 9:01 a.m., Joerg Schad wrote: --- This is an automatically generated e-mail. To reply, visit: https://reviews.apache.org/r/36193/ --- (Updated July 6, 2015, 9:01 a.m.) Review request for mesos, Benjamin Hindman, Bernd Mathiske, and Joseph Wu. Repository: mesos Description --- Improved Doxygen-Styleguide for clarifying discussions arising from https://reviews.apache.org/r/36141/. Diffs - docs/mesos-doxygen-style-guide.md 72156c72fc40f72740e57d47d0436c60f6d05bd7 Diff: https://reviews.apache.org/r/36193/diff/ Testing --- Checked rendered markdown. Thanks, Joerg Schad
Re: Review Request 36193: Improved Doxygen-Styleguide.
On July 6, 2015, 6:39 p.m., Joseph Wu wrote: docs/mesos-doxygen-style-guide.md, line 102 https://reviews.apache.org/r/36193/diff/1/?file=999588#file999588line102 This isn't part of the diff, but should this `@note` tag be replaced with a `**NOTE:**`? Good catch! But not part of this review, do you want to create another patch for this? - Joerg --- This is an automatically generated e-mail. To reply, visit: https://reviews.apache.org/r/36193/#review90525 --- On July 6, 2015, 9:01 a.m., Joerg Schad wrote: --- This is an automatically generated e-mail. To reply, visit: https://reviews.apache.org/r/36193/ --- (Updated July 6, 2015, 9:01 a.m.) Review request for mesos, Benjamin Hindman, Bernd Mathiske, and Joseph Wu. Repository: mesos Description --- Improved Doxygen-Styleguide for clarifying discussions arising from https://reviews.apache.org/r/36141/. Diffs - docs/mesos-doxygen-style-guide.md 72156c72fc40f72740e57d47d0436c60f6d05bd7 Diff: https://reviews.apache.org/r/36193/diff/ Testing --- Checked rendered markdown. Thanks, Joerg Schad
Re: Review Request 36193: Improved Doxygen-Styleguide.
--- This is an automatically generated e-mail. To reply, visit: https://reviews.apache.org/r/36193/#review90529 --- docs/mesos-doxygen-style-guide.md (line 17) https://reviews.apache.org/r/36193/#comment143651 It might be worthwhile to emphasize that markdown syntax can/should be used in with the comment blocks. I think Javadocs generally use plain HTML for links, tables, etc. - Joseph Wu On July 6, 2015, 2:01 a.m., Joerg Schad wrote: --- This is an automatically generated e-mail. To reply, visit: https://reviews.apache.org/r/36193/ --- (Updated July 6, 2015, 2:01 a.m.) Review request for mesos, Benjamin Hindman, Bernd Mathiske, and Joseph Wu. Repository: mesos Description --- Improved Doxygen-Styleguide for clarifying discussions arising from https://reviews.apache.org/r/36141/. Diffs - docs/mesos-doxygen-style-guide.md 72156c72fc40f72740e57d47d0436c60f6d05bd7 Diff: https://reviews.apache.org/r/36193/diff/ Testing --- Checked rendered markdown. Thanks, Joerg Schad
Re: Review Request 36193: Improved Doxygen-Styleguide.
--- This is an automatically generated e-mail. To reply, visit: https://reviews.apache.org/r/36193/#review90486 --- Patch looks great! Reviews applied: [36193] All tests passed. - Mesos ReviewBot On July 6, 2015, 9:01 a.m., Joerg Schad wrote: --- This is an automatically generated e-mail. To reply, visit: https://reviews.apache.org/r/36193/ --- (Updated July 6, 2015, 9:01 a.m.) Review request for mesos, Benjamin Hindman, Bernd Mathiske, and Joseph Wu. Repository: mesos Description --- Improved Doxygen-Styleguide for clarifying discussions arising from https://reviews.apache.org/r/36141/. Diffs - docs/mesos-doxygen-style-guide.md 72156c72fc40f72740e57d47d0436c60f6d05bd7 Diff: https://reviews.apache.org/r/36193/diff/ Testing --- Checked rendered markdown. Thanks, Joerg Schad
