doxygen

问题 In C/C++, you can force doxygen to recognize that a comment applies to the text preceding it on a line. Any of these: int my_variable; /*!< This is my variable */ int my_variable; /**< This is my variable */ int my_variable; //!< This is my variable int my_variable; ///< This is my variable adds the string to the documentation for my_variable . Trying the equivalent in Python doesn't seem to work. This works: ## This is my variable my_variable = None This: my_variable = None ## This is my

问题 I have a project where I have a substantial amount of conditional defines for making cross platform development easier. However I'm having issues convincing Doxygen to extract all the defines, as it will only pick up ones that only happened to evaluate. For example in the following snippet, Doxygen will document TARGET_X86_64 but not TARGET_ARM64 . #if defined(_M_ARM64) || defined(__arm64__) || defined(__aarch64__) /** Build target is ARM64 if defined. */ #define TARGET_ARM64 #else /** Build

问题 I have a project where I have a substantial amount of conditional defines for making cross platform development easier. However I'm having issues convincing Doxygen to extract all the defines, as it will only pick up ones that only happened to evaluate. For example in the following snippet, Doxygen will document TARGET_X86_64 but not TARGET_ARM64 . #if defined(_M_ARM64) || defined(__arm64__) || defined(__aarch64__) /** Build target is ARM64 if defined. */ #define TARGET_ARM64 #else /** Build

问题 Which Doxygen option can completely disable sorting members by type (Private / Public / Method / Variable), and output members purely based on the order in which they were declared? 回答1: This is impossible via the config options. The best you can do is: SORT_MEMBER_DOCS = NO which disables alphabetical sorting of members. 来源： https://stackoverflow.com/questions/1385775/can-doxygen-output-members-purely-in-order-of-declaration

问题 My current project is a C++ application. The documentation is generated with doxygen, and comments are formatted accordingly. The project also includes several xml resource files, with comments. I would like to include them in the documentation. Here is an illustration of the kind of thing I would like to do : Input (file used by my application, myFile.xml): <!-- @brief settings used by class MyClass at startup @image html screenshot_default.jpg --> <Myclass_settings id="default_setting">

问题 As it currently stands, this question is not a good fit for our Q&A format. We expect answers to be supported by facts, references, or expertise, but this question will likely solicit debate, arguments, polling, or extended discussion. If you feel that this question can be improved and possibly reopened, visit the help center for guidance. Closed 7 years ago . I'm writing a tool and I need to generate the callgraph for some C projects. I was able to generate the callgraph of one file using

问题 My development environment consists of Git repository, GitLab repository manager and Jenkins. During build process a documentation is generated with Doxygen in HTML format. Is it possible to store that documentation on GitLab project's wiki? I know that HTML is not supported in Gollum, which is the Gitlab's wiki engine. Converting HTML to Markdown is not satisfactory because of internal links in HTML files that point to other HTML files. Should I store documentation in a separate wiki instead

问题 My development environment consists of Git repository, GitLab repository manager and Jenkins. During build process a documentation is generated with Doxygen in HTML format. Is it possible to store that documentation on GitLab project's wiki? I know that HTML is not supported in Gollum, which is the Gitlab's wiki engine. Converting HTML to Markdown is not satisfactory because of internal links in HTML files that point to other HTML files. Should I store documentation in a separate wiki instead

问题 We have a number of makefile templates, that realize certain build actions by setting a few parameter makefile variables, and applying a makefile template via inclusion like GENERIC_PARAM1-y := paramA GENERIC_PARAM2-y := paramB include $(MAKE_TOOLS)/doaction.mk And files like doaction.mk contain make templates to generate standard rule definitions that are applied when just including the action make step. Now we want to document these interfaces for the *.mk snippets using Doxygen like ##

问题 I'm documenting a c++ project for college with Doxygen, and everything is correct, but the dependency graph shows like this: I would like that the graph doesn't show inclusions such as list, map or string, and only includes custom Classes i created for the project, but i can't find anything online or on the docs. Does anyone know how to do this? 回答1: Since you want to exclude the stdlib container classes, you should probably add the std:: namespace to your doxyfile: EXCLUDE_SYMBOLS = std::*