Skip to content

Feature/doxygen latex

Jonathan Fisher requested to merge feature/doxygen-latex into develop

I have updated the doxygen configuration and cmakelists. There is now a new build target docs which is enabled by passing -DNSX_DOCS=ON during cmake config. Then running make docs will build the doxygen documentation inside build/docs. Some important things to note:

  • Doxygen will process markdown files in source/docs/md. I have added a sample index.md and authors.md to get started.
  • Markdown files can link to classes/source files and vice versa.
  • Doxygen will generate warnings for undocumented classes and methods. These will be written to build/docs/warnings.log
  • Latex (via mathjax) is supported both in doxygen comments and markdown. Syntax as follows \f$y = x^2\f$ for inline latex and $$y = x^2$$ for displayed latex.

Merge request reports