【问题标题】:Doxygen autolink not working to global enum typesDoxygen 自动链接不适用于全局枚举类型
【发布时间】:2010-06-03 11:22:15
【问题描述】:

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

update1:我使用的是 Doxygen 1.6.3 版

update2:全局结构没问题

【问题讨论】:

    标签: doxygen


    【解决方案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;
    

    【讨论】:

      【解决方案2】:

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

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

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

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

      /*! \file */ 
      
      or a
      
      /** @file */ 
      
      line in this file.
      

      【讨论】:

        猜你喜欢
        • 2021-09-07
        • 1970-01-01
        • 1970-01-01
        • 1970-01-01
        • 1970-01-01
        • 1970-01-01
        • 1970-01-01
        • 2014-10-07
        • 1970-01-01
        相关资源
        最近更新 更多