This topic has moved to the DM Developer guide at https://developer.lsst.io.
|
Doxygen is currently the mechanism by which detailed documentation is generated for DM-authored source code. This page offers pointers to on-line documentation, as well as tips for handling common situations that may require a little finesse. Veterans of DM documentation should record nuggets of expertise here.
Be sure to read the Documentation Standards, which is the official standard for the project.
Not surprisingly, the best source for Doxygen knowledge is on-line:
A few capabilities require a little special effort. Here are a few tips:
Copy the doc string of the __init__ method:
\copydoc \_\_init\_\_ |
To make Doxygen parse special commands within python docstrings, begin the string with an exclamation point:
"""!Example command-line task that computes statistics on an image \section pipeTasks_ExampleCmdLineTask_Contents Contents - \ref pipeTasks_ExampleCmdLineTask_Purpose """ |
Related articles appear here based on the labels you select. Click to edit the macro and add or change labels.