我没有让 doxygen 预处理器递归地包含文件。这个怎么做?
我制作了一个包含两个头文件和一个 Doxygen 文件的示例:
subdir/example.h
subdir2/example_include.h
Doxygen
这是清单example.h
:
#include "example_include.h"
typedef struct
{
float array[ARRAY_LENGTH * 2 - 1];
#if CONDITION == MY_FALSE
char optional_char;
#endif
} ExampleType;
这是清单example_include.h
:
#define MY_FALSE (0u)
#define MY_TRUE (1u)
#define CONDITION MY_TRUE
#define ARRAY_LENGTH (20u)
我对默认 Doxygen 配置文件(使用 Doxygen 1.8.2)的更改是:
INPUT = .
RECURSIVE = YES
GENERATE_XML = YES
MACRO_EXPANSION = YES
INCLUDE_PATH = .
ExampleType
(file: )的 Doxygen 的输出 XMLxml/struct_example_type.xml
是:
<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<doxygen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="compound.xsd" version="1.8.2">
<compounddef id="struct_example_type" kind="struct" prot="public">
<compoundname>ExampleType</compoundname>
<sectiondef kind="public-attrib">
<memberdef kind="variable" id="struct_example_type_1aa7b8f391fc62f93c34c2b305542db339" prot="public" static="no" mutable="no">
<type>float</type>
<definition>float ExampleType::array[ARRAY_LENGTH *2-1]</definition>
<argsstring>[ARRAY_LENGTH *2-1]</argsstring>
<name>array</name>
<briefdescription>
</briefdescription>
<detaileddescription>
</detaileddescription>
<inbodydescription>
</inbodydescription>
<location file="D:/Sandboxes/ALN_Alignment_SRR295/04_Engineering/01_Source_Code/algo/exmaple/subdir/example.h" line="5" bodyfile="D:/Sandboxes/ALN_Alignment_SRR295/04_Engineering/01_Source_Code/algo/exmaple/subdir/example.h" bodystart="5" bodyend="-1"/>
</memberdef>
<memberdef kind="variable" id="struct_example_type_1a8428371f21c1fb8fd28cb1062c7b1152" prot="public" static="no" mutable="no">
<type>char</type>
<definition>char ExampleType::optional_char</definition>
<argsstring></argsstring>
<name>optional_char</name>
<briefdescription>
</briefdescription>
<detaileddescription>
</detaileddescription>
<inbodydescription>
</inbodydescription>
<location file="D:/Sandboxes/ALN_Alignment_SRR295/04_Engineering/01_Source_Code/algo/exmaple/subdir/example.h" line="7" bodyfile="D:/Sandboxes/ALN_Alignment_SRR295/04_Engineering/01_Source_Code/algo/exmaple/subdir/example.h" bodystart="7" bodyend="-1"/>
</memberdef>
</sectiondef>
<briefdescription>
</briefdescription>
<detaileddescription>
</detaileddescription>
<location file="D:/Sandboxes/ALN_Alignment_SRR295/04_Engineering/01_Source_Code/algo/exmaple/subdir/example.h" line="4" bodyfile="D:/Sandboxes/ALN_Alignment_SRR295/04_Engineering/01_Source_Code/algo/exmaple/subdir/example.h" bodystart="3" bodyend="9"/>
<listofallmembers>
<member refid="struct_example_type_1aa7b8f391fc62f93c34c2b305542db339" prot="public" virt="non-virtual"><scope>ExampleType</scope><name>array</name></member>
<member refid="struct_example_type_1a8428371f21c1fb8fd28cb1062c7b1152" prot="public" virt="non-virtual"><scope>ExampleType</scope><name>optional_char</name></member>
</listofallmembers>
</compounddef>
</doxygen>
实际上,我希望ARRAY_LENGTH
被结构取代(20u)
并且optional_char
不应该成为结构的成员。
我的问题似乎与此有关,但唯一有希望的答案是@Phineas 的评论说这是一个已在 doxygen 版本 1.7.4 中修复的问题。但是,我仍然看到相同的行为。该怎么办?
顺便说一句 - “用例”很简单:这是一个视觉工作室项目。编译器根据需要包含所有文件,因为它们都包含在项目定义中。