doxygen | 易学教程

Use of sections within a module group in doxygen

阅读更多关于 Use of sections within a module group in doxygen

问题 I seek the preferred way to structure the contents of a doxygen module group. For example I want to structure the @details text in the following module group in different sections. Especially each of the sections should appear in the bookmarks of the generated PDF (as child elements of the module group): @defgroup lorem @{ @brief Lorem ipsum @details Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Ut purus elit, vestibulum ut, placerat ac, adipiscing vitae, felis. Curabitur dictum

Use of sections within a module group in doxygen

阅读更多关于 Use of sections within a module group in doxygen

Doxygen: Empty Detail Description

阅读更多关于 Doxygen: Empty Detail Description

问题 Context - Doxygen tool on C codes to generated RTF documents. In the documentation of Modules/Groups, we are getting the header "Detailed Description" even if no detail description is provided for some particular module/group. In generated RTF document this looks ugly. Is it possible to get rid of this empty Detail Description sections? I tried "ALWAYS_DETAILED_SEC = NO" but it is not working. I cannot do "HIDE_UNDOC_MEMBERS = YES" as the group/module contains members (struct, functions ...)

How to be able to extract comments from inside a function in doxygen?

阅读更多关于 How to be able to extract comments from inside a function in doxygen?

问题 I'm interested to know if it is possible to have some comments in a function (c, c++, java) in a way that doxygen could put them in the generated html file. for example: function(...) { do_1(); /** * Call do_2 function for doing specific stuff. */ do_2(); } 回答1: No, doxygen does not support comments blocks inside function bodies. From the manual: Doxygen allows you to put your documentation blocks practically anywhere (the exception is inside the body of a function or inside a normal C style

使用Doxygen来生成Box2d的API文档

阅读更多关于使用Doxygen来生成Box2d的API文档

【推荐】2019 Java 开发者跳槽指南.pdf(吐血整理) >>> 对于Doxygen以前只听别人说过，而现在使用它也是一个偶然，缘分吧。前两天看box2d的官方sdk中，发现他有用户手册却没有说明，只是留下了一个Doxygen的文件。事情告一段落，然后今天在看box2d的例子的时候发现他的函数里都有注释即对函数的使用说明，这才让我想起了Doxygen，有了它，可以轻松生成自己最喜欢的chm格式的API文档。而且网上的api文档不好找。 csdn的教程链接： http://blog.csdn.net/flyoxs/article/details/7558175 这是给大家参考的至于今天我就给大家一个例子，用doxygen生成Box2d的api文档。先下载doxygen的向导程序doxygenwizard,然后安装，操作如下下载地址可以到上面的csdn博客中查找网址。 file->open->box2d(你的box2d目录)/documention->选择doxygen的文件打开，随便点几个选项想发现人家已经帮你配置好了，这里我们直接生成。 run->run doxygen。等一会就会生成一堆html。这里认为html已经满足需要的就不用往下面看了。如下图: 但是html格式不是我想要的，我需要的是一个pdf文档和chm文档所以需要进行下面的步骤: 点击wizard-

How to document python function parameter types?

阅读更多关于 How to document python function parameter types?

问题 I know that the parameters can be any object but for the documentation it is quite important to specify what you would expect. First is how to specify a parameter types like these below? str (or use String or string ?) int list dict function() tuple object instance of class MyClass Second, how to specify params that can be of multiple types like a function that can handle a single parameter than can be int or str ? Please use the below example to demonstrate the syntax needed for documenting

Link to external mainpage

阅读更多关于 Link to external mainpage

问题 I have made a Doxygen documentation, which itself references another documentation using the tag-file mechanism. But inside its mainpage I now would like to link to the mainpage of the external documentation. Of course, I can always specify the file directly: ... uses [OtherDoc](../../../OtherProject/doc/html/index.html) for ... even more so since the projects are located relative to each other. But nevertheless I would like Doxygen to automate this process, since it needs to know the

Parse files without extensions

阅读更多关于 Parse files without extensions

问题 I'm setting up the doxygen for a project. The module files have their language standard extension (.py), but the executable scripts do not. How can I get doxygen to read these correctly (Python in this case)? I tried EXTENSION_MAPPING = ''=Python But that looks for files named "blah.". I'm on a Unix system, so the concept of a file extension doesn't even exist here. And this is an existing project, so renaming all of the existing scripts is not an option. Any ideas? 回答1: I modified doxygen to

Using regular expressions in python to determine C++ functions and their parameters

阅读更多关于 Using regular expressions in python to determine C++ functions and their parameters

问题 So I'm doing something wrong in this python script, but it's becoming convoluted and I'm losing sight of what I'm doing wrong. I want a script to go through a file, find all the function definitions, and then pull out the name, return type, and parameters of the function, and output a "doxygen" style comment like this: /******************************************************************************/ /*! \brief Main function for the file \return The exit code for the program */ /***************

Using C# Attributes and documentation

阅读更多关于 Using C# Attributes and documentation

问题 Let's consider the following source code. /// <summary> /// This is a method I would like to document /// </summary> /// <param name="param1">Description for param1</param> /// <param name="param2">Description for param2</param> /// <returns>See Type1</returns> [Api(1)] public Type1 Method1( [ApiParam(Name = Names.Name1, IsRequired = true)] string param1 string param2 ) { ... } /// <summary> /// This is a method I would like NOT to document /// </summary> public void Method2() { ... } My