Question

最近,我们在使用MACROS收集时间时添加了一些代码,以贴标签。现在,Doxygen没有适当记录折旧功能。

    #if defined(__GNUC__)
    #define DEPRECATED(func) func __attribute__((deprecated)) /**< mark a function as deprecated in gcc. */ 

    #elif defined(_MSC_VER)
    #define DEPRECATED(func) __declspec(deprecated) func /**< mark a function as deprecated in msvc. */
    #endif

注是该员额的宏观版本,即实际的宏观方法确实是编篡者版本检查等。

Later the macros are used around a function to let the compiler know that the function has been deprecated so a compiler warning will be issued.

    /**
     * myMethod() is deprecated.
     */
    DEPRECATED(
        /**
         * @deprecated
         * Description of deprecated function
         * 
         * @param var this is a parameter
         *
         * @return this is returned 
         */
        int myMethod(int var)
    );

The problem is that Doxygen wants to show the documentation for DEPRECATED not for myMethod(int var).

是否有任何人知道如何用Doxygen来记录我的血友,而不是宏观的DEPRECA。

Answer 1

You should tell doxygen that it has to remove the DEPRECATED macro. You can do this using the following preprocessor options in the configuration file:

ENABLE_PREPROCESSING   = YES
MACRO_EXPANSION        = YES
EXPAND_ONLY_PREDEF     = YES
PREDEFINED             = "DEPRECATED(x)=x"

您可以通过使用<代码>-d Preprocessor 选项的 d氧来推断预处理结果。如果存在这一选择,Doxygen将在进行预处理后将投入文件提交产出。

更多信息见。

Answer 2

Use the @fn tag to explicitly tell what the block is referring to. Not as convenient as the implicit connection, but safer.

友情链接