Multidisciplinary-design Adaptation and Sensitivity Toolkit (MAST) - Sensitivity-enabled multiphysics FEA for design
GNU Lesser General Public License v2.1
43
stars
24
forks
source link
Doxygen output formatting & class documentation style guidelines #68
Open
jdeaton opened 4 years ago
One thing that would make the generated API documentation more readable is to move the "Detailed Description" to the top of the page. This can be done by providing a layout file (https://stackoverflow.com/questions/19831837/documenting-with-doxygen-put-details-on-top).
It would also be useful to provide some consistent guidelines for documenting all classes and work towards them.