标签: doxygen

我对Doxygen(Mac OS X Snow Leopard上的1.6.1)有一个相当奇怪的问题,因为无论我做什么,它似乎都没有记录我的枚举.我正在用C语言编程并遵循手册中的说明.这是我的代码:

/**
 * \enum dccp_pkt_type 
 * \brief specifies the available DCCP packet types
 */

enum dccp_pkt_type
{
    DCCP_REQUEST    = 0,    /**< DCCP Request Packet */
    DCCP_RESPONSE,          /**< DCCP Response Packet */
    DCCP_DATA,              /**< DCCP Data Packet */
    DCCP_ACK,               /**< DCCP Ack Packet */
    DCCP_DATAACK,           /**< DCCP Data Ack Packet */
    DCCP_CLOSEREQ,          /**< DCCP Close Request Packet */
    DCCP_CLOSE,             /**< DCCP Close Packet */
    DCCP_RESET,             /**< DCCP Reset Packet */
    DCCP_SYNC,              /**< DCCP Sync Packet */
    DCCP_SYNCACK, …

我有一个带有一组降价页面的项目,这些页面与链接相互关联

[Go to this page](subdir/MyOtherPage.md)

这些页面都被doxygen选中并出现在输出中,但链接不会改变为指向新的html再现.

我可以将链接更改为指向html页面,但我的项目托管在github上,然后这些链接将被破坏,因为github支持自动在markdown页面之间进行链接.

我在doxygen文档中看不到任何关于支持除外部链接之外的链接的内容.有没有办法让doxygen从降价产生HTML链接？

例如,我将源代码路径设置为c:\ code\testapp\src.这是否可以作为我可以使用的var - 例如我可以在相对于此的位置吐出标签文件,而不是相对于doxygen的工作目录？我想我正在寻找像Ant如何为几乎所有东西定义变量的东西,这些可以重复使用; Doxygen对任何配置值都有特殊的变量吗？

我想的是$ PROJECT-NAME或%VERSION%或者其他......

我已将此添加到课堂评论中:

@link http://www.google.com Google @endlink

但是,当我使用doxygen生成文档时,链接文本确实是"Google",但链接是:

文件:///media/portable/Examples/Doxygen/link/html/classClass1.html

谁能解释出了什么问题？

我知道可以在注释中使用markdown,doxygen可以理解它.但我需要知道是否有可能以降价格式生成文档？

我需要从C++文件生成这些文档.

我有一个目录,其中保存所有源文件和头文件.我想运行Doxygen来生成这些源代码的文档.但是,我不想更改此目录中的任何内容(特别是我无法添加将保存Doxygen文档的子目录).

我怎样才能达到我的需要？

我想我需要做以下事情: - 我创建并转到'documentation'目录.- 在此目录中,我执行doxygen -g以创建名为"Doxyfile"的模板配置文件. - 然后,我想,我需要修改Doxyfile以指示源代码不在当前目录中.

那么,输出会自动(默认情况下)保存在执行Doxygen的目录中吗？

@param命令的可选方向参数在此处记录为以下之一:

@param[in]
@param[out]
@param[in,out]

我没有在任何示例网站中看到此信息如何出现在输出中.是否有一个例子说明这些信息应该如何出现在输出中？

使用Xcode,我希望在自动完成选项下面有我方法的Doxygen描述,如alloc:

在编写时,Xcode会显示自动完成以及文档中的注释.您可以在图像中看到,例如,alloc从选项中选择何时,它会显示"返回接收类的新实例",并且还链接到文档.

例如,我已经能够用Doxygen记录我的源代码

/** 
 This does nothing
*/
 -(void) doNothing
{
    // This does nothing
}

我在Doxygen生成的HTML文件中得到了预期的结果,但我不知道如何使这些结果在Xcode中显示为建议.

我想为计算机视觉领域的项目,模块和库集合准备一份文档(主要用c ++编写).为此,我查看了OpenCV文档,您可能知道OpenCV 2.4.x文档基于Sphinx,这是我寻求的确切解决方案.Sphinx的优点是:

1. 从语义角度看模块的层次结构.例如,卡尔曼滤波器是运动分析和对象跟踪模块的子代
2. 您可以添加图像和数学公式
3. 相当不错的嵌入式搜索引擎

但我意识到OpenCV3.0的c ++版本是基于Doxygen记录的,我不知道为什么!因为它没有Sphinx那么有趣.我知道Doxygen可以编译你的代码并提取你的评论,这是一个有用的功能.我也知道有些库(如呼吸)可以作为Doxygen和Sphinx之间的桥梁.

现在我的问题是:

1. 彼此的Sphinx和Doxygen替代品还是可以和它们一起使用？
2. Doxygen是否具有Sphinx所提到的功能？
3. 您更喜欢哪个文档引擎(Sphinx,Doxygen或其他引擎)？

我注意到doxygen 1.8.2有一个奇怪的问题.包含标题标签会导致标题标题从输出html中消失.

使用以下markdown文件:

Title            {#title}
=====

Section 1        {#section1}
---------
Text for section 1

我得到的输出为:

标题

第1节的文字

但是,如果我{#section1}从markdown文件中删除标签,我会得到正确的输出:

标题

第1节

第1节的文字

我在这里犯的错是什么？

编辑我在标记部分时发现了以下警告:

 warning: found subsection command outside of section context!