doxygen プリプロセッサが再帰的にファイルをインクルードすることができません。これを行う方法?
2 つのヘッダーと 1 つの 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: xml/struct_example_type.xml
)に対する Doxygen の出力 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
そうすべきではありません。
私の質問はこれに関連しているようですが、唯一の有望な答えは、doxygen バージョン 1.7.4 で修正された問題であるという @Phineas のコメントです。ただし、まだ同じ動作が見られます。これをどうするか?
ところで - 「ユースケース」は単純です。これはビジュアル スタジオ プロジェクトです。すべてのファイルがプロジェクト定義に含まれているため、コンパイラは必要に応じてすべてのファイルを含めます。