Question

我有一个简单的问题：如何记录.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？

Answer 1

Doxygen希望/**或///启动一个支持doxygen的注释块。我不知道它是否有效，但我会尝试评论：

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

Answer 2

要向doxygen添加自定义文件扩展名，您必须在配置文件中编辑两件事：

FILE_PATTERNS通常包含val a: ParArray[(Double, Double, Double, Double, Double)] = ??? val rdd = sc.parallelize(a.seq)
EXTENSION_MAPPING为public class HomeFragment extends BasePageFragment { private Unbinder unbinder; // @BindView(R.id.fab) // FloatingActionButton mFab; @Nullable @Override public View onCreateView(LayoutInflater inflater, ViewGroup container, Bundle savedInstanceState) { return inflater.inflate(R.layout.fragment_homepage, container, false); ImageButton ImageButton = (ImageButton) FindViewById (R.id.imageButton); ImageButton.setOnClickListener(new View.OnClickListener() { @Override public void onClick(View v) { Uri uri = Uri.parse("https://play.google.com/store/apps/details?id=com.mowmo.minimale"); startActivity(new Intent(Intent.ACTION_VIEW, uri)); } }); }，其中解析器为C，C＃，C ++，Python等。

在您的情况下设置＆＃39; .extension＆＃39; as＆＃39; .ini＆＃39;和＆＃39;解析器＆＃39;作为C. Doxygen需要以下*.extension \或.extension=parser两行。它还接受多行///和//! OR
设置解析器＆＃39;到了Python＆＃39;使用/**样式注释，因为#i接受＃作为注释，但不建议使用。这应该可以消除你的需要; s

Answer 3

我会说Doxygen缺乏记录功能

构建脚本
配置文件
自定义脚本，可在您自己的虚拟机中使用

所以最终的解决方案是分叉Doxygen，并添加处理任意语言的能力，如Notepad ++或Kate。在路上，您还应该清理其凌乱的2002式HTML输出，这样它就不再生成div汤。

Doxygen-如何使用非标准扩展名（.INI）记录文件

3 个答案: