как документировать сгенерированные конструкторы в doxygen - PullRequest
5 голосов
/ 23 февраля 2011

Мы используем doxygen для документирования наших занятий.Я хотел бы явно задокументировать, что класс сгенерировал конструкторы и / или деструкторы, чтобы указать, что я подумал об этом и решил, что, например, копирование с использованием сгенерированного конструктора копирования безопасно.Однако конструктор / деструктор не объявлен и, следовательно, doxygen не знает, к какой функции относится документация.Есть ли способы сделать так, чтобы doxygen включал комментарии к функциям, даже если функция никогда не объявлялась?

//! The Foo class documentation
class Foo {
    //! @fn Foo(const Foo&) 
    //! Generated copy constructor OK to use

    //! method documentation
    void method();
}

Также я бы вообще не хотел писать подпись сгенерированных файлов.

Полагаю, другой вариант - просто описать это в заголовке класса.Есть ли другие подходы?

1 Ответ

1 голос
/ 23 февраля 2011

Если вы используете понятие = default, введенное в C ++ 0x для ваших сгенерированных по умолчанию конструкторов, doxygen должен забрать их

http://www2.research.att.com/~bs/C++0xFAQ.html#default

Я не знаю, есть ли у doxygenреализовал новые ключевые слова и шаблоны C ++ 0x, хотя

...