[
https://issues.apache.org/jira/browse/MESOS-3581?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=14943234#comment-14943234
]
Benjamin Bannier edited comment on MESOS-3581 at 10/5/15 11:09 AM:
-------------------------------------------------------------------
A possible solution would be to use an {{INPUT_FILTER}} in the {{Doxyfile}} to
preprocess the opening part of the license header comments; this would have
minimal impact on the source tree, but should probably be implemented in some
way that minimalizes external deps.
Another solution would be to simply fix the openers like shown in the
description; the possibility of this creating merge problems is small as only a
single line at the beginning of files needs to be touched. It would however
somewhat pollute the history of 800+ files with non-functional changes.
was (Author: bbannier):
A possible solution would be to use an `INPUT_FILTER` in the `Doxyfile` to
preprocess the opening part of the license header comments; this would have
minimal impact on the source tree, but should probably be implemented in some
way that minimalizes external deps.
Another solution would be to simply fix the openers like shown in the
description; the possibility of this creating merge problems is small as only a
single line at the beginning of files needs to be touched. It would however
somewhat pollute the history of 800+ files with non-functional changes.
> 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)
