Как я могу исключить метод внутри класса с doxygen

Question

Я использую Objective-C язык. И у меня 3 класса: курица, голубь, собака. Каждый из классов имеет метод run.

Chicken.h 
-(void)run; 

Dove.h 
-(void)run; 

Dog.h 
-(void)run; 

Я хочу исключить метод запуска внутри класса Dove. Я обнаружил, что EXCLUDE_SYMBOLS может это сделать. Но если я настрою конфигурацию: EXCLUDE_SYMBOLS = save, все методы сохранения в 3 классах исключены.

Могу ли я исключить метод сохранения только класса Dove?

Answer 1

Я не знаю цель-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.