| Info |
|---|
| Note: These instructions apply for OpenSim versions 3.x |
...
| Install Package | Description |
|---|---|
| Doxygen | Primary installation to turn .h file files into html files. Can either download the installer or clone from github. |
| Latex generates rendered equations that are easier to read and interpret. Latex and dvips are installed through the protext | TeXStudio distribution (protext is very large ~2Gb). Protext installer can install a number of packages, the TeXstudio install puts latex and dvips on system path. | |
| Ghostscript does some further rendering of pictures and text. Download and install the gs914w32.exe distro |
...
- 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