![]() ![]() (keywords) which start with an at-sign See Doxygen special commands for the complete list More details in the documentation can be provided using special Doxygen’s special commands Int var ///< Brief description after the member Doxygen commands ¶ In Marian, weįollow the Javadoc style, which consist of a C-style comment block starting with two *’s, ![]() Doxygen basics ¶ĭoxygen recognises several special comment blocks with some additional markings. Code documentation with Doxygen ¶ĭoxygen is a powerful documentation system for C++ and many other languages that parses andĮxtracts documentation comments included in the source code to generate a comprehensiveĭocumentation, for example, in HTML or LaTeX format. The existing code might not follow these guidelines, but new code should. There is an ongoing and incremental effort with the goal of documenting essential Marian API in aĬonsistent way. Your Doxygen comments will be integrated in the Marian’s documentation New Doxygen comments or update existing ones as needed along with your changes (see the Doxygen ![]() Whenever you add new code or propose changes to Marian, we would highly appreciate if you also add Marian’s documentation is generated using Sphinx + Breathe + Doxygen + Exhale.ĭoxygen is used for documenting the source code and Sphinx (together with the extensions ofīreathe and Exhale) for managing handwritten documentation and generating library API ![]()
0 Comments
Leave a Reply. |
AuthorWrite something about yourself. No need to be fancy, just an overview. ArchivesCategories |