我使用Doxygen记录了我的代码,但是找不到在文档中添加#define值的方法。 我尝试在这里找到这个

  /**
  * @brief test
  */
   #define definedValue @"aValue"

===============>>#1 票数:0

如果希望定义的值出现在文档中,则可以使用\\ showinitializer命令。 使用以下命令,文档注释也可以与#define出现在同一行:

#define definedValue @"aValue" /**< Description of defined variable */

===============>>#2 票数:0

这应该工作:

/**
 * \def definedValue
 *
 * @brief test
 */
#define definedValue @"aValue"

另请参阅: http : //www.doxygen.nl/manual/commands.html#cmddef

  ask by Red Mak translate from so

未解决问题?本站智能推荐:

1回复

如何在Doxygen中忽略文档“定义值名称”

我有一个名为“ Document_System”的定义值。 我的问题是我想在生成的文档中忽略此定义值name(Document_System) 。 //macroHeader.h //myHeader.h 是否可以仅记录system_check()而不是Document_
1回复

Doxygen文档所有条件定义

我有一个项目,我有大量的条件定义,使跨平台开发更容易。 但是我在说服Doxygen提取所有定义时遇到了问题,因为它只会选择那些只发生在评估中的定义。 例如,在下面的代码片段中,Doxygen将记录TARGET_X86_64但不记录TARGET_ARM64 。 启用EXTRACT_
1回复

Doxygen中预处理器的组级文档

我有一个C / C ++头文件,该文件定义了多组预处理器符号。 这些组中的每个组都应在组级别具有自己的文档,并且应针对组中的每个符号使用单行文档。 我使用defgroup / addtogroup建立组,每个组都很好地显示在Modules选项卡中,其中带有所需的符号。 我无法实现的
4回复

记录预处理器在Doxygen中定义

是否有可能在Doxygen中记录预处理器定义? 我希望能够像变量或函数那样做,但Doxygen输出似乎“丢失”了定义的文档,并且也不包含定义本身。 我尝试了以下内容 和 我也尝试将它们放在一个组(尝试defgroup,addtogroup和ingroup)而不是仅仅在“文
1回复

Doxygen C预处理程序宏文档样式

我刚刚注意到Doxygen为C预处理程序宏生成文档的方式中有一些有趣的事情。 在Doxygen手册中的三种创建块注释的样式( /// , //!和/** */ ,只有前两种样式( /// , //! )会在文件的宏列表上显示简短描述。 我的问题是:这是设计使然吗? 我有一个控制此的配置
7回复

如何通过在C文件中记录#defines来保持doxygen?

我在标题中有#define值,我当然希望Doxygen记录,但我在C文件中有其他我认为是静态常量,我不希望Doxygen记录它们。 像傻瓜一样简单愚蠢的东西 如何让Doxygen不将这些#define放入它创建的文档中? 我试过用@internal标记它,但似乎没有帮助。 关于
1回复

防止Doxygen进行条件编译(编译器内部定义)

我有很多代码基于编译器提供的定义进行条件编译,而不是代码本身或外部标头中的任何定义。 例如,我经常出现以下情况: 我需要为特定于platofm / compiler的部分中的所有代码生成文档,但是我不能简单地将ENABLE_PREPROCESSING设置为NO,因为根据该文档,INCL
1回复

C预处理器中的双氧,如果

我用Doxygen记录了我的C代码并遇到问题。 考虑以下示例: 在define.h中: 在test.c中 Doxygen找到了testFunc1并对其进行了很好的记录,但是找不到testFunc2。 在.doxyfile中定义ENABLED不会解决我的问题。 有没
1回复

用于C模板仿真的Doxygen

我正在尝试使用Doxygen为C中的模拟模板生成文档而没有太大成功。 我希望有人知道如何在doxygen预处理器中使宏技巧工作? 我已经尝试过启用“MACRO_EXPANSION”而没有运气。 编辑:这个问题最变性的形式是:“我怎样才能使Doxygen以与C预处理器类似的方式处理预处理
2回复

扩展注释的注释(对于doxygen)

在运行预处理程序之前,注释通常会转换为单个空格。 但是,有一个引人注目的用例。 #pragma once #ifdef DOXYGEN #define DALT(t,f) t #else #define DALT(t,f) f #endif #define MAP(n,a,