[
https://issues.apache.org/jira/browse/MESOS-3581?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=14965341#comment-14965341
]
Joseph Wu commented on MESOS-3581:
----------------------------------
IMO, more importantly, we should actually update the Doxygen docs. They were
last updated 13 months ago. (See linked issues)
Also, we can easily get rid of the license headers by actually documenting the
classes.
For example, the [Watcher
class|http://mesos.apache.org/api/latest/c++/classWatcher.html] has proper
documentation *and* a license.
> 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
>
> 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)
