[ https://issues.apache.org/jira/browse/MESOS-3581?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=15011268#comment-15011268 ]
Benjamin Bannier commented on MESOS-3581: ----------------------------------------- After discussion with [~benjaminhindman] decided that using C++-style comments {{// ..}} instead of C-style block comments {{/** .. */}} would reduce the number of used comment styles mostly to C++-style comments and Doxygen comments. Also added a linter to check license headers in C++, C, and protobuf files, review is here https://reviews.apache.org/r/40445/. > License headers show up all over doxygen documentation. > ------------------------------------------------------- > > Key: MESOS-3581 > URL: https://issues.apache.org/jira/browse/MESOS-3581 > Project: Mesos > Issue Type: Documentation > Components: documentation > Affects Versions: 0.24.1 > Reporter: Benjamin Bannier > Assignee: Benjamin Bannier > Priority: Minor > Labels: mesosphere > > Currently license headers are commented in something resembling Javadoc style, > {code} > /** > * Licensed ... > {code} > Since we use Javadoc-style comment blocks for doxygen documentation all > license headers appear in the generated documentation, potentially and likely > hiding the actual documentation. > Using {{/*}} to start the comment blocks would be enough to hide them from > doxygen, but would likely also result in a largish (though mostly > uninteresting) patch. -- This message was sent by Atlassian JIRA (v6.3.4#6332)