Doxygen如何使用非标准扩展名(.INI)记录文件
我有一个简单的问题:如何记录.INI文件Doxygen如何使用非标准扩展名(.INI)记录文件,doxygen,Doxygen,我有一个简单的问题:如何记录.INI文件 我有一个C++项目,其布局如下: readme.txt src main.cpp data simple.ini 从readme.txt和main.cpp生成文档没有问题,但是simple.ini中的文档根本不会显示在html输出中。我已修复了Doxygen文件,其中包括以下内容: INPUT = . src data FILE_PATTERNS = *.cpp *.txt *.ini 这没有帮助。我还明确指定simple.ini:
我有一个C++项目,其布局如下:
readme.txt
src
main.cpp
data
simple.ini
从readme.txt和main.cpp生成文档没有问题,但是simple.ini中的文档根本不会显示在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?doxygen需要
/**
或//
来启动doxygen感知注释块。我不知道它是否有效,但我会尝试以下方式进行评论:
; /// @file simple.ini
; /// This file will do blah blah blah
...
我想说,Doxygen缺乏记录功能
- 构建脚本
- 配置文件
- 在您自己的虚拟机中使用的自定义脚本
因此,最终的解决方案是fork-Doxygen,并添加处理任意语言的能力,如Notepad++或Kate。在此过程中,您还应该清理其凌乱的2002样式HTML输出,使其不再生成div soup。要向doxygen添加自定义文件扩展名,您必须在配置文件中编辑两个内容:
- 文件模式通常包含扩展名
*。扩展名\
< LIXEXION映射为
//
或//代码>。它还接受多行/**
和/*代码>
或
将“parser”设置为“Python”以使用##
样式的注释,因为.ini接受#作为注释,但不推荐使用。这应该会消除你的需要;s谢谢你,穆维西尔,这很有效。然而,@code和@endcode块之间的文本输出是混乱的:它包括“;”因为Doxygen没有识别“;”作为注释字符。现在,我使用一个同名的.TXT文件来记录我的.INI文件。