4.5.4. Embedding Links and Equation in Doxygen Comments - 4.5.4. Embedding Links and Equation in Doxygen Comments - 5.3 English - 68552

AOCL API Guide (68552)

Document_ID
68552
Release_Date
2026-05-13
Version
5.3 English

A special doxygen command was made to be able to embed restructured text in Doxygen comments.

* @rst
* write your rst code here such as references: `link to chapter introduction <C_intro>`_
* @rst

Note that the leading asterisk is mandatory for this command to work. See aoclda-handle.h for an example.