Is there a way to create documentation using QDoc for global functions?
-
Hi.
I am using QDoc to document my project.
For class functions, I was able to document them using the \fn command.
However, even if I wrote a same command in the global function, it was not output to html.
Is there any way to document global functions?
For example, for the main function in main.cppOr is this possible using Doxygen instead of QDoc?
Thanks for your help.
-
Hi.
I am using QDoc to document my project.
For class functions, I was able to document them using the \fn command.
However, even if I wrote a same command in the global function, it was not output to html.
Is there any way to document global functions?
For example, for the main function in main.cppOr is this possible using Doxygen instead of QDoc?
Thanks for your help.
@ynakane said in Is there a way to create documentation using QDoc for global functions?:
Or is this possible using Doxygen instead of QDoc?
Not only possible but recommended. QDoc is an internal tool used only to document Qt itself. For all other code, use Doxygen.
-
@ynakane said in Is there a way to create documentation using QDoc for global functions?:
For example, for the main function in main.cpp
main.cpp is not normally used for any functions that need to be documented. Create the class for any functionality and then use QDoc commands for documentation.