Report
1 year, 7 months ago.

Can't figure out how to create documentation

I've seen these links describing how to create documentation for the project:

https://docs.mbed.com/docs/mbed-os-api-reference/en/latest/APIs/API_Documentation/

http://www.stack.nl/~dimitri/doxygen/manual/markdown.html#md_page_header

And I am still not clear as to how I enable documentation for my program especially when I want to add an additional overview page written in markdown.

So, here are questions:

1. what's the name of the doxygen configuration file? According to Doxygen documentation https://www.stack.nl/~dimitri/doxygen/manual/config.html the name is Doxyfile. Unfortunately, this file name cannot be created from web interface. Does file need to go to root project directory?

2. How to include main.cpp in the documentation? It seems that another file needs to include a reference. Does it mean I have to create main.h just to include main.cpp? I'd like to include it from overview documentation file.

These 2 issues seem to be blocking any of my ability to create documentation for the program.

Comment on this question

1 Answer

1 year, 7 months ago.

By default the documentation process documents libraries not programs. I can't remember the exact distinction but adding the directive:

/** @file main.cpp
 */

To the main file caused it to be processed for documentation.


To post an answer, please log in.