2009-10-25 9 views
11

Chcę wykluczyć klasę z dokumentacji w Doxygen. Zwykle te klasy są w plikach o tej samej nazwie, ale wiele razy są one zawarte w innych definicjach klas. Dotyczy to głównie klas rozpoczynających się od "_" lub "Prywatnych".W jaki sposób Doxygen może wykluczyć klasę C++?

Jak mogę powiedzieć Doxygen, aby wykluczyć klasę C++?

Z góry dziękuję.

Odpowiedz

14

Możesz użyć the \cond tag. Przed definicją klasy, dodać:

\cond HIDDEN_SYMBOLS 

i po definicji klasy dodać:

\endcond 

ile można zdefiniować HIDDEN_SYMBOLS w doxyfile zawartość między \cond i \endcond tagów nie będą dokumentowane. Możesz zamienić HIDDEN_SYMBOLS na co tylko chcesz.

+0

Czy można to zrobić w źródłach bez '\ cond' i' \ endcond'? Może coś w rodzaju "\ nodoc" lub "\ nodoxygen" na zajęciach? Nie widziałem polecenia w instrukcji Doxygen w [Special Commands] (https://www.stack.nl/~dimitri/doxygen/manual/commands.html), ale być może przegapiłem to. – jww

1

Używanie Doxygen GUI można znaleźć wielokrotność wyklucza możliwości pod

"expert > input" 

Może się okazać szczególnie przydatne:

  • Wykluczenie symboli: Nie zawiera wszystko, zawierający określoną słowo regex jak /słowo/
  • Wyklucz wzorce: wyklucza określone wyrażenie regex, takie jak /folder/ lub /so ja/file.cs/
Powiązane problemy