mast-multiphysics icon indicating copy to clipboard operation
mast-multiphysics copied to clipboard

Doxygen output formatting & class documentation style guidelines

Open jdeaton opened this issue 5 years ago • 0 comments

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.

  • http://www.doxygen.nl/manual/docblocks.html

jdeaton avatar Feb 07 '20 19:02 jdeaton