doxygen

问题 i've activated warnings with doxygen WARNINGS = YES WARN_IF_UNDOCUMENTED = YES WARN_IF_DOC_ERROR = YES WARN_NO_PARAMDOC = YES But undocumented methods like this one: void AnimationManager::setAnimationTimeStep( double timeStep ) { ... } Do not throw any warning during doxygen generation. Is there any way to display warning in this situation ? Same problem with undocumented return , for example /** * @brief brief description */ bool AnimationManager::hasAnimationTimeStep( ) { ... } Does not

问题 I've run into a problem with PHP 5.3 namespacing and Doxygen comments. Example: /** * Sample Method * * @param string $output * @return \Project\Lib\Rest */ Doxygen gives me the following warnings: warning: Found unknown command `\Project' warning: Found unknown command `\Lib' warning: Found unknown command `\Rest' What can I do to fix this or turn off \commands and only use @commands 回答1: Try escaping your backslashes, i.e. use /** * Sample Method * * @param string $output * @return \

问题 Is there a way to have doxygen show the documentation for individual private functions? I want doxygen to not show the documentation for the vast majority of private functions but show it for a select few private functions. My motivation is that these C++ private functions are provided to Python as extensions and I want their documentation to show up in Doxygen. However, I don't want them to be public because they are only needed by the classes themselves; they definitely belong in the

问题 I have added a \dir comment to give a directory additional documentation. But I am unable to link to that directory documentation using any of the doxygen linking techniques that I know. My question is: how do I properly link to the documentation of a directory? Below is a snippet of what I have tried. I get two warnings and no generated links. The Automatic Linking section of doxygen manual discusses Links to other members, but it does not mention links to dirs. Is linking to directory

问题 All classes of my library are defined within a namespace. When I create a mainpage for Doxygen I have to explicitly use this namespace within comments to make Doxygen generate links. I would like to use something like "using namespace" for the whole comment block. An example: /** * \mainpage My Library * * Use MyLibraryNamespace::MyClass to ... */ Here Doxygen automatically generates a link to the documentation of MyLibraryNamespace::MyClass. /** * \mainpage My Library * * Use MyClass to ...

问题 I am trying to use doxygen to generate documentation for some matlab classes I have written. I am using the doxygen-matlab package, which includes a perl script to kludge matlab .m files into c++ style commented files, so that doxygen can read them. In my doxyfile, I have set (according to the instructions) FILTER_PATTERNS = *m=C:/doxygenMatlab/m2cpp.pl However, when the code runs, rather than running the script on the input files, it appears to just open the script using whatever the default

问题 I am using doxygen to document C++ code. Let's say I have two classes: class Base and class Derived derived from Base. I have a member group with named Foo in both Base and Derived. Is it possible to make doxygen to show a single group named Foo in documentation for class Derived instead of having two identically named groups as I observe now? 回答1: I patched a checkout of doxygen to do this. The patch is below. I haven't noticed any ill effects in the generated documentation. The downside of

问题 In my code, a vtable containts several function pointer. Doxygen is unable to follow them. I'd like to force it to recognize the possible paths, to produce a complete Call Graph, since now this part is missing. example: typedef Bool(*SPECIAL_FUNC)(KEY key); typedef struct{ int a; int b; SPECIAL_FUNC; }OBJ; Bool add(KEY key); //code... Bool sub(KEY key); //code... 回答1: While this will likely not affect the call graph in doxygen, you can document the functions as related to the structure, and

问题 Closed. This question is off-topic. It is not currently accepting answers. Want to improve this question? Update the question so it's on-topic for Stack Overflow. Closed last year . How do I produce Qt-style documentation (Trolltech's C++ Qt or Riverbank's PyQt docs) with Doxygen? I am documenting Python, and I would like to be able to improve the default function brief that it produces. In particular, I would like to be able to see the return type (which can be user specified) and the

问题 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