Szukam sposobu na tłumienie ostrzeżeń oxygen dotyczących nieudokumentowanych funkcji składowych, ale bez używania //! @cond
i //! @endcond
, więc funkcje członkowskie wciąż pojawiają się w streszczeniu klasa. Coś jak następuje:Wyłączenie ostrzeżenia o dooksygen dla nieudokumentowanej funkcji członka, ale pozostawienie streszczenia w miejscu
class Foo
{
public:
Foo();
Foo(const Foo&);
Foo& operator=(const Foo&);
};
tych funkcji członkowskich zrobić rzeczą oczywistą i nie wymagają dokumentacji, ale nadal mają być wyświetlane na liście dostępnych funkcji składowych w dokumentacji (bo wiedząc, że klasa jest sprawy do skopiowania/przypisania). Jak to jest, doxygen emituje "nie udokumentowane" ostrzeżenie dla każdego z nich. Jeśli użyję //! @cond
i //! @endcond
, metody znikną całkowicie z dokumentacji. Chciałbym, żeby metody pozostały widoczne w dokumentacji, ale bez dalszych komentarzy, i chcę, żeby tlen nie narzekał na to, że są nieudokumentowane.
Czy jest jakiś rodzaj "fikcyjnego komentarza", który mówi doxygenowi, aby zamknął się z powodu braku dokumentu, ale nadal zachowuje metody w dokumentacji, aby były widoczne?
Czy potrzebna jest zmienna konfiguracyjna ['WARN_IF_UNDOCUMENTED'] (http://www.stack.nl/~dimitri/doxygen/manual/config.html#cfg_warn_if_undocumented)? Ustaw na "NIE", a Doxygen nie wyda tych ostrzeżeń. Możesz również ustawić ['EXTRACT_ALL'] (http://www.stack.nl/~dimitri/doxygen/manual/config.html#cfg_extract_all) na" YES ". – Chris
To nie jest to, o co mi chodzi. Chcę wyłączyć ostrzeżenie dla kilku metod, ale zachować ostrzeżenie dla innych nieudokumentowanych metod. W zasadzie to, co chciałbym, to coś w rodzaju '//! @ nowarn' i '//! @ endnowarn'. W ten sposób mógłbym uzyskać cichą kompilację bez wielu ostrzeżeń, ale nadal otrzymuję powiadomienia o metodach, które powinny być udokumentowane, ale nie są. –