Doxygen autolink不适用于全局枚举类型

时间:2010-06-03 11:22:16

标签: doxygen

我正在尝试使用Doxygen Automatic link generation来记录某些enum类型。但是,它不会为全局enum类型生成链接。它确实为全局struct类型生成链接。有什么我想念的吗?我正在使用上面链接中提供的示例。根据需要,我已经记录了定义类型的文件。

update1 :我使用的是Doxygen版本1.6.3

update2 :全局结构正常

2 个答案:

答案 0 :(得分:1)

是的,我有同样的问题;我认为doxygen认为他们是私人或类似的东西。尝试使用\public。不要忘记在第一行执行/*!

/*! \public
 * Enum description goes here
 */
typedef enum {

    /**
     * Printer control language ZPL
     */
    PRINTER_LANGUAGE_ZPL,

    /**
     * Printer control language CPCL
     */
    PRINTER_LANGUAGE_CPCL

} PrinterLanguage;

答案 1 :(得分:0)

我遇到了同样的问题。一些头文件生成了枚举的链接,而其他头文件则没有。您必须明确记录该文件。

以下是文档中此页面的摘录。 http://www.doxygen.nl/manual/docblocks.html#memberdoc

  

记录全局C函数,typedef,enum或预处理器   定义您必须首先记录包含它的文件(通常是   这将是一个头文件,因为该文件包含信息   导出到其他源文件)。

     

注意       让我们重复一遍,因为它经常被忽视:要记录全局对象(函数,typedef,枚举,宏等),你必须   记录定义它们的文件。换句话说,那里   必须至少是一个

/*! \file */ 

or a

/** @file */ 

line in this file.