如何在doxygen中隐藏一个特定的函数(在c++中)?

hujrc8aj  于 2023-02-06  发布在  其他
关注(0)|答案(4)|浏览(331)

我有一个类,有很多函数,我想隐藏一个特定的函数。

class Test
{

   /**
    * About Function1
    *
    * @param[in]  arg1  About arg1
    * @param[in]  arg2  About arg2
    */        
    public void Function1(int arg1,char arg2);

    // Presume same documentation for this function also
    public void Function2(int,char);

    // Presume same documentation for this function also
    public void Function3(int,char);

    // Presume same documentation for this function also
    public void Function4(int,char);
}

假设我想隐藏函数2,我该怎么做呢?
现在,在当前场景中,它显示了所有四个函数沿着文档。
现在,我在.doxygen规则文件中设置了以下属性:
EXTRACT_ALL = YES
你能建议我一些东西,我可以隐藏说函数2?

8ehkhllq

8ehkhllq1#

如果您在配置文件中有EXTRACT_PRIVATE = NO,那么您可以将任何成员标记为对Doxygen私有,并且它不会为该成员生成文档:

/// @private
public void Function2(int, char);

附加问题:如果要对所有四个成员使用相同的文档,可以使用以下方法之一:

/// @{
/**
 * About Function1,2,3,4...
 */
public void Function1(int arg1, char arg2);
public void Function2(int arg1, char arg2);
public void Function3(int arg1, char arg2);
public void Function4(int arg1, char arg2);
/// @}

/**
 * About Function1,2,3,4...
 */
public void Function1(int arg1, char arg2);
/// @copydoc Function1
public void Function2(int arg1, char arg2);
/// @copydoc Function1
public void Function3(int arg1, char arg2);
/// @copydoc Function1
public void Function4(int arg1, char arg2);

使用@{ ... @}的方法需要在配置文件中使用DISTRIBUTE_GROUP_DOC = YES

2cmtqfgy

2cmtqfgy2#

使用电导率或内部

/*! \cond PRIVATE */
//only documented if cond is enabled
// ...
/*! \endcond */
deikduxw

deikduxw3#

请执行以下操作:

#ifndef DOXYGEN_SHOULD_SKIP_THIS

 /* code that must be skipped by Doxygen */
 /* in your case a method/function */

#endif /* DOXYGEN_SHOULD_SKIP_THIS */

在配置文件中,输入PREDEFINED = DOXYGEN_SHOULD_SKIP_THIS确保ENABLE_PREPROCESSING设置为YES
简而言之,您只是在利用预处理器概念来为您工作!

qyuhtwio

qyuhtwio4#

我想我曾经使用EXCLUDE_SYMBOLS来实现类似的功能。
EXCLUDE_SYMBOLS标记可用于指定应从输出中排除的一个或多个符号名(名称空间、类、函数等)。符号名可以是完全限定名、单词或子字符串(如果使用了通配符 )。示例:名称空间,A类,A类::名称空间,名称空间:: 测试
不幸的是,我不能完全回忆,也没有找到配置条目。

EXCLUDE_SYMBOLS = Test::Function2*

相关问题