[MESOS-3581] License headers show up all over doxygen documentation.

• Type: Documentation
• Status: Resolved
• Priority: Minor
• Resolution: Fixed
• Affects Version/s: 0.24.1
• Fix Version/s: 0.27.0
• Component/s: documentation
• Labels: mesosphere
• Sprint: Mesosphere Sprint 22, Mesosphere Sprint 23
• Story Points: 2
• Assignee: Benjamin Bannier
• Reporter: Benjamin Bannier
• Shepherd: Michael Park
• Created: 05/Oct/15 08:38
• Updated: 26/Nov/18 09:28
• Resolved: 26/Nov/18 09:28

Description

Currently license headers are commented in something resembling Javadoc style,

/**
* Licensed ...

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.

Issue Links

• is blocked by: MESOS-1186 Generate C++ docs with doxygen.
• is blocked by: MESOS-2827 Broken Doxygen rake target for generating website.