To get started with Doxygen-based
documentation for your project you will create a
docs directory under your project directory,
and there create the Doxyfile configuration
file.
You can also create any input or resource files that you may need in this directory.
This section identifies a few Doxgen configuration settings you can consider.
You can set PROJECT_NAME manually:
PROJECT_NAME = "My Project"
or have it automatically set, based on the name of the project directory as follows:
PROJECT_NAME = $(PROJNAME)
This allows you to create a mainpage for your documentation that is written in Markdown. Something like this is good:
USE_MDFILE_AS_MAINPAGE = ./docs/README.md
As well as being able to create whole project documentation, individual libraries can be separately documented.
This is done just as for projects, by creating a docs
subdirectory within the library directory, and creating a
suitable Doxyfile.
Project documentation can be built by invoking:
dno docs in the project root directory;
dno docs in the project docs directory;
dno in the project docs directory.
Library documentation can be built by invoking:
dno docs in the library directory;
dno docs in the library's docs directory;
dno in the library's docs directory.