如何使用doxygen排除类中的方法

时间:2015-06-02 09:56:33

标签: objective-c doxygen

我使用的是Objective-C语言。我有3个班:鸡,鸽子,狗。每个类都有run方法。

Chicken.h
 -(void)run;

Dove.h
 -(void)run;

Dog.h
 -(void)run;

我想在Dove类中排除run方法。我发现EXCLUDE_SYMBOLS可以做到这一点。但如果我设置配置:EXCLUDE_SYMBOLS = save,则排除3个类中的所有保存方法。

我是否只能排除Dove类的保存方法?

1 个答案:

答案 0 :(得分:1)

我不知道objective-c,但对于C ++,我知道这样做的唯一方法就是预处理它。为此,请设置配置值:

ENABLE_PREPROCESSING   = YES
PREDEFINED             = DOXYGEN_SHOULD_SKIP_THIS

然后将您想要排除的方法包装在ifndef块中。这是一个C ++示例:

/// doc comment for class Dove
class Dove {
public:
    /// doc comment for foo
    void foo();

#ifndef DOXYGEN_SHOULD_SKIP_THIS
    // the bar method will not be seen by doxygen, so you should not
    // see it in any documentation
    void bar();
#endif
}; 

这是您可能使用的一般策略。 #ifndef块内的任何内容都将被预处理掉,并且不会显示为doxygen。