Syntax Guide

Here you can see how you have to write your comments in doxygen for doxysphinx to pick them up.

• Rst Block Syntax
  • TLDR; Recommended Syntax
  • Markers
  • Supported rst block delimiters in doxygen comments
  • More examples
• Rst Inline Syntax
  • TLDR; Recommended Syntax
  • Technical Details
  • Supported rst inline delimiters in doxygen comments
  • More examples
• Comment Syntax
  • Supported Doxygen Comment Styles