代码之家 › 专栏 › 技术社区 › Hai Vu

Doxygen如何记录扩展名为(.INI)的非标准文件

doxygen

Hai Vu · 技术社区 · 15 年前

我有一个简单的问题:如何记录.INI文件?

我有一个C++项目,其布局如下:

readme.txt
src
    main.cpp
data
    simple.ini

从readme.txt和main.cpp生成文档没有问题,但是simple.in I中的文档根本不显示在html输出中。我已经修复了Doxygen文件,使其包含以下内容:

INPUT = . src data
FILE_PATTERNS = *.cpp *.txt *.ini

那没用。我还明确指定simple.ini:

INPUT = readme.txt data/simple.ini src

但也没用。在simple.ini中,我使用“;”作为注释:

; @file simple.ini
; This file will do blah blah blah
[section1]
key1 = foo
key2 = bar
...

我还试图使用'#'作为注释字符,但它也不起作用。如何使doxygen处理simple.ini?

3 回复 | 直到 15 年前

mouviciel 15 年前

多氧预期 /** 或 /// 用于启动doxygen感知注释块。我不知道它是否有效,但我想试着评论一下:

; /// @file simple.ini
; /// This file will do blah blah blah
...

LikeTheRock 9 年前

要向doxygen添加自定义文件扩展名,必须在配置文件中编辑两项内容:

通常包括扩展名的文件模式 *.extension \
扩展映射为 .extension=parser 其中解析器是C、C、C、C++、Python等。

在您的案例中,将“.extension”设置为“.ini”,将“parser”设置为C。 Doxygen需要以下两行代码 /// 或 //! . 它也接受多线 /** 和 /*! .
或者
将“parser”设置为“Python”以使用 ## 虽然不推荐使用样式注释作为注释,但.ini将其接受为注释。这将消除您对

-1

user877329 11 年前

我认为强力霉素缺乏记录

生成脚本
配置文件
在您自己的虚拟机中使用的自定义脚本

所以最终的解决方案是使用fork Doxygen,并添加处理任意语言的能力,比如Notepad++或Kate。在这个过程中,您还应该清理它混乱的2002样式的HTML输出,这样它就不再生成div so up了。

推荐文章

Dale Barnard · 如何阻止Doxygen为C#项目生成包索引?

8 年前

Rishu Mehra · 页面未显示在Doxygen文档中

8 年前

xMutzelx yamini jhamnani · SVN关键字显示在doxygen中

8 年前

Ganesh K · JSDoc-指定强制参数语法

9 年前

much · doxygen:一个描述框中有两个makro

10 年前

holroy · 结构doxygen的所有引用列表

11 年前

Issam T. · doxygen中引用运算符的问题

12 年前

Hi-Angel · DoxyGen忽略函数

12 年前

georg · doxygen忽略封装在语句中的类

12 年前

Stefan · Doxygen:代码列表中的每一行都以星号(*)开头

12 年前