![]() ![]() ![]() Then add the Doxygen output to the table of contents () This project has Demo Doxygen Docs here, which was achieved using the configuration here and the table of contents set here. I can even make a list: * * item 1 * * item 2 * * item 3 * * \param a this is one input parameter * \param b this is another * \param c and this is the output * * \author L. We need to create an empty Sphinx project, and add the following Python code to the Sphinx It is nothing special but asking the OS to call to generate the Doxygen documentation HTML and copy it to the Sphinx Comparing with Sphinx, Doxygen is relatively simpler to use. A special documentation block is a C or C++ style comment block with some additional markings, so doxygen knows it is a piece of documentation that needs to end. Assuming Doxygen documentation is already configured correctly, call the rundoxygen method in the configuration file (conf.py) located in the docs folder. ![]() The / tells Doxygen to expect keywards with signs in front of them to. * I could add many more details here if I chose to do so. Each documentation block comment has to start with /, and end with the customary /. There are subtleties in how Doxygen treats the different types of. - /*! \brief Example function * * \details **myfunction()** takes a and b as arguments and miraculously creates c. Doxygen provides quite a few different alternative styles for documenting the source code. ![]()
0 Comments
Leave a Reply. |
AuthorWrite something about yourself. No need to be fancy, just an overview. ArchivesCategories |