Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Info
Note: These instructions apply for OpenSim versions 3.x

...

  • The doxygen comments that appear in the html file for each class are generated from a classes header file. 
  • The best way to get oriented to doxygen is to review some examples. Some well documented classes include:
    • ModelComponent
    • MuscleCurveFunctionFactor
  • If you update the doxygen comments for a class, rebuild the "doxygen" target to check that there are no errors and your documentation appears as expected. 
  • The doxygen manual also provides information about the available commands and usage: http://www.stack.nl/~dimitri/doxygen/manual.html
  • Doxygen only generates documentation from .h files, not .cpp files.
  • Convention for figures: fig_CLASSNAME_FIGNAME