Documentation 如何在Doxygen中使用与安装选项交互的条件

Documentation 如何在Doxygen中使用与安装选项交互的条件,documentation,doxygen,Documentation,Doxygen,在发布问题之前,我已经搜索了该网站,但没有找到答案 我的任务是为一个软件创建一个用户手册,该软件有不同类型硬件的安装选项。更清楚地说,用户选择硬件A、B或C等的安装。然后会启用一些功能,而禁用一些功能 用户手册基本上是一个文本文件(.txt),其中还包括相关的Doxygen命令(addtogroup、defgroup、ref等) 我试图找出如何在用户手册中自动添加一些信息,例如硬件A,如果安装选项A不包括硬件B的信息 我搜索了Doxygen手册和各种论坛,包括这一个,到目前为止,我想出了一个笨拙

在发布问题之前,我已经搜索了该网站,但没有找到答案

我的任务是为一个软件创建一个用户手册,该软件有不同类型硬件的安装选项。更清楚地说,用户选择硬件A、B或C等的安装。然后会启用一些功能,而禁用一些功能

用户手册基本上是一个文本文件(.txt),其中还包括相关的Doxygen命令(addtogroup、defgroup、ref等)

我试图找出如何在用户手册中自动添加一些信息,例如硬件A,如果安装选项A不包括硬件B的信息

我搜索了Doxygen手册和各种论坛,包括这一个,到目前为止,我想出了一个笨拙的想法,但它不起作用

*** This is my manual.txt file. The following is the relevant piece. ***

/*! \defgroup info1 Scripts
    \ingroup manual
    Several  scripts are provided to help the user perform sophisticated tasks. 

\if \$(OPTION_SETUP)=OPTION1
    <ul>
    <li> \ref option1_related_section 
    <li> \ref option1_related_example_text 
    </ul>
\endif

\if \$(OPTION_SETUP)=OPTION2
    <ul>
    <li> \ref option2_related_section
    <li> \ref option2_related_example_text
    </ul>
\endif
*/
***这是我的manual.txt文件。以下是相关内容***
/*! \defgroup info1脚本
\组内手册
提供了几个脚本来帮助用户执行复杂的任务。
\如果\$(选项设置)=选项1
  • \ref option1\u相关章节
  • \ref option1\u相关\u示例\u文本
\恩迪夫 \如果\$(选项设置)=选项2
  • \ref option2\u相关章节
  • \ref option2\u相关\u示例\u文本
\恩迪夫 */
这是行不通的。 我不是开发人员,我知道我遗漏了一些东西

我看到\if和\cond仅与节名一起使用。 但是我不知道如何使用条件选择manual.txt(这是我们的用户手册,不是开发人员手册)上的文本片段,这取决于安装选项


对于Doxygen,这实际上是可能的吗?

\if和\cond等。仅使用Doxyfile中已启用的部分中定义的变量(对于这种情况,您可以使用带&、| |和!)的简单表达式。因此,不能在此处使用带有“=”的表达式。 在您的情况下,可以创建两个doxyfile,一个用于选项A,另一个用于选项B,请注意,这些doxyfile可以通过include语句共享部分。在一个Doxyfile中,您将在ENABLED_部分和另一个OPTION2中定义OPTION1,if语句将分别读取\if OPTION1和另一个\if OPTION2