doxygen

问题 I've got some C code from a 3rd party vendor (for an embedded platform) that uses global variables (for speed & space optimizations). I'm documenting the code, converting to Doxygen format. How do I put a note in the function documentation that the function requires on global variables and functions? Doxygen has special commands for annotating parameters and return values as describe here: Doxygen Special Commands. I did not see any commands for global variables. Example C code: extern

问题 I've got some C code from a 3rd party vendor (for an embedded platform) that uses global variables (for speed & space optimizations). I'm documenting the code, converting to Doxygen format. How do I put a note in the function documentation that the function requires on global variables and functions? Doxygen has special commands for annotating parameters and return values as describe here: Doxygen Special Commands. I did not see any commands for global variables. Example C code: extern

问题 I've got some C code from a 3rd party vendor (for an embedded platform) that uses global variables (for speed & space optimizations). I'm documenting the code, converting to Doxygen format. How do I put a note in the function documentation that the function requires on global variables and functions? Doxygen has special commands for annotating parameters and return values as describe here: Doxygen Special Commands. I did not see any commands for global variables. Example C code: extern

问题 I've got some C code from a 3rd party vendor (for an embedded platform) that uses global variables (for speed & space optimizations). I'm documenting the code, converting to Doxygen format. How do I put a note in the function documentation that the function requires on global variables and functions? Doxygen has special commands for annotating parameters and return values as describe here: Doxygen Special Commands. I did not see any commands for global variables. Example C code: extern

问题 Every time I create a .cpp/.h file on CLion, I get an automatic file header like this: // // Created by me on 09/11/18. // This is neat, but I'd rather like something Doxygen-compliant like this: /*! * @author me * @date 03/12/18. */ I could easily edit this and add more Doxygen-fields thanks to the nice CLion integration. This seems a trivial task, but I still did not manage to achieve it. May someone help me out? Regards, Edit: As suggested, I went to "File and Code Templates", then clicked

问题 I have a question about pages and groups in doxygen. I have a project, where I grouped classes etc. with the @defgroup and @ingroup cmds. So far this works fine. Now I'd like to add special documentation to the project with markdown pages. These pages should appear in the dedicated module (group). I tried to create pages with the @page and @subpage cmds. That works fine, but the pages appear plain in the menu. So I tried to add them to the groups with @ingroup. But that doesn't work as I

问题 I have a question about pages and groups in doxygen. I have a project, where I grouped classes etc. with the @defgroup and @ingroup cmds. So far this works fine. Now I'd like to add special documentation to the project with markdown pages. These pages should appear in the dedicated module (group). I tried to create pages with the @page and @subpage cmds. That works fine, but the pages appear plain in the menu. So I tried to add them to the groups with @ingroup. But that doesn't work as I

问题 My question is related to how to comment typedef in template class with Doxygen. I will give an example to illustrate my question: namespace fundamental { /** * Basic function */ template <typename T> class Base { public: T x; ///< x coordinate T y; ///< y coordinate }; typedef Base<float> Coordinate; ///< Point coordinate class } After using Doxygen to process the above codes, I can obtain a HTML page to show the definition of the class Base. However, for the typedef class Coordinate, it

问题 I'm new to using Doxygen. As I mentioned in the title, I want to change the name of the title I gave in the Markdown file according to the output language. For example, I can give a static title like this: @page AIPage AIHeader In this way, I can add something to the page in the output language I choose: \~english Hello \~turkish Merhaba Unfortunately, when I use the same usage in the title, I cannot get any results: @page AIPage \~english Hello|\~turkish Merhaba How can I solve this problem?

问题 I want to generate doxygen documentation with a predefined foo.doxyfile. I want to modify e.g. the PROJECT_NUMBER and generate the documentation with a bat-file. Here is the content of the bat: @echo off setLocal enabledelayedexpansion cls echo Running Doxygen rem Set a lot of variables set BASE_DIR=%~dp0 set "PathToDoxygen=C:\Program Files\Doxygen\bin\doxygen.exe" set "PahtToInterfacesDoxygen=D:\foo\Interfaces\Interfaces.doxyfile" call ( type doxyfile & echo "PROJECT_NUMBER=1.1.2" | "