Doxygen-如何记录具有非标准扩展名（.INI）的文件 [英] Doxygen-how to document files with non-standard extension (.INI)

问题描述

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

I have a simple question: how do I document .INI file?

我有一个C ++项目，其布局如下：

I have a C++ project with the following layout:

readme.txt
src
    main.cpp
data
    simple.ini

我没有问题，可以从readme.txt和main.cpp生成文档，但是simple.ini中的文档不会显示在html中输出。我更正了Doxygen文件，使其包含以下内容：

I have no problem generating document from readme.txt and main.cpp, but the document in simple.ini does not show in the html output at all. I have fixed the Doxygen file to include the following:

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

。我还明确指定了simple.ini：

That did not help. I also explicitly specify simple.ini:

INPUT = readme.txt data/simple.ini src

但它也不起作用。在simple.ini中，我使用;作为注释：

But it did not work either. Within simple.ini, I use ';' for comment:

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

我也尝试使用'＃'来注释字符，但也没有用。我该如何使doxygen处理simple.ini？

I also tried to use '#' for comment char, but it did not work, either. How do I make doxygen to process simple.ini?

推荐答案

Doxygen期望<​​code> / ** 或 /// 用于启动可识别脱氧核糖的注释块。我不知道它是否有效，但我会尝试评论：

Doxygen expects /** or /// for starting a doxygen-aware comment block. I don't know if it works, but I would try to comment with:

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

这篇关于Doxygen-如何记录具有非标准扩展名（.INI）的文件的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！