是否有办法为包含注释的.ini
配置文件自定义HTML输出,例如:
[MySection]
;This is an extensive description of MyParameter (possibly with @commands after semicolon?)
MyParameter=MyValue
尽管这是一个特殊用法,但我想让每个参数分别解析/列出描述(以及单位?和推荐值?)。该文件也可能如下所示:
[MySection]
;@brief A brief description
;@details A detailled description
;@unit cows (The physical unit of the parameter)
;@recommendedValue 5 cows
MyParameter=7
目前,我将.ini
文件与@include/@verbinclude
包括在内 - 遗憾的是,没有语法突出显示。感谢。
答案 0 :(得分:1)
好的,我假设您使用FILE_PATTERNS
标记包含了该文件,因此至少文档列在您的文档中。此外,您必须设置EXTENSION_MAPPING
标记以告诉doxygen如何解释此文件。不幸的是,doxygen不支持INI文件语法。此时您有两种可能性:
编写自定义输入过滤器(例如在perl中)并将其添加为INPUT_FILTER
改变注释,以便doxygen解析器获得与您在EXTENSION_MAPPING
中定义的编程语言相对应的有效代码。
例如,如果您设置了EXTENSION_MAPPING = ini=C
那么您的inifile应该如下所示:
;/// @file myinifile.ini
;/// @brief A brief description.
;/// @details A detailled description.
;/// @unit cows (The physical unit of the parameter)
;/// @recommendedValue 5 cows
MyParameter=7
;
需要额外的斜杠///
来告诉doxygen解析器该行是注释行,该行应由doxygen处理。
另请注意最后一个分号;
,因为doxygen C解析器在每次声明后都期望结束;
。