Triangle& operator=( const Triangle& triangle) * The reference to the current Triangle object. * Get a vector of the Triangle objects whose side lengths have been rotated. * Construct a new Triangle object from another Triangle object.
Triangle( const double a, const double b, const double c) * Create a new Triangle object from side lengths. * Triangle(const double a, const double b, const double c) * Create a new Triangle object of side lengths 1, 1, and 1. * Triangle class used for triangle manipulations.
#DOXYGEN DOCUMENTATION GENERATOR#
VS Code extension Doxygen Documentation Generator could also be used for generating the docstring template. The Doxygen C++ docstrings are not complicated. Set to YES if we would like to have Sphinx-styled documentations. Whether recursively go through the INPUT. The directory for the source code to be documented. The output directory for the documentation builds. One sentence description about the project. There are a couple of things in the Doxyfile that might or must be configured. The installation of the library and the building of the documentation could be found in the READMEs in the repository. The documentation corresponding to this project could be found on Read the Docs. The C++ trianglelib could be found in the Doxygen C++ TriangleLib on my GitHub.
#DOXYGEN DOCUMENTATION HOW TO#
In this blog post, I would like to briefly describe how to create documentations using Doxygen and host it on Read the Docs. Unlike Sphinx which uses several reStructuredText files and source code for creating documentations, all the documentation content generated using Doxygen seems to be only from the source code.
I have created a trivial Triangle C++ library, which is equivalent to the Triangle Python library I used for the Sphinx Python documentation blog post, and used Doxygen for creating documentations. For creating documentations for C/C++ development, Doxygen is more widely used and technically easier to use. In my previous blog post, I discussed how to create documentations for Python development using Sphinx.
0 kommentar(er)
