Jak mogę zapisać doxygen dokumentację #defines w pliku C?

Question

Mam wartości #define w nagłówkach, które z pewnością chcę, aby Doxygen dokumentował, ale mam inne pliki C, które traktuję jako stałe statyczne i nie chcę, aby Doxygen je dokumentował. Coś tak proste i głupie jak

#define NUMBER_OF(a) (sizeof((a))/sizeof((a)[0])) 
#define MSTR(e) #e 

Jak mogę utrzymać Doxygen od wprowadzenia tych #define S w dokumentacji go tworzy? Próbowałem go oznaczyć za pomocą @internal, ale to nie pomogło.

Nieco związanych pytanie na Doxygen i #define, jak mogę dostać:

#define SOME_CONSTANT 1234 /**< An explanation */ 

umieścić "SOME_CONSTANT" i "an wyjaśnienie", ale nie "1234" na wyjściu?

Answer 1

Możesz wykluczyć jakąkolwiek część kodu z parsowania Doxygen przy pomocy tagów \cond\endcond.

EDIT: Niektóre pytania związane z:

• How can Doxygen exclude a C++ class?
• Exclude some classes from doxygen documentation

Answer 2

Będzie to bez wątpienia nadal wydają głośny i nienaturalne, ale adres drugą pytanie, spróbuj:

/** An explanation */ 
#define SOME_CONSTANT /** @cond */ 1234 /** @endcond */ 

Answer 3

Możesz ustawić MAX_INITIALIZER_LINES = 0 w swoim pliku doxy, aby ukryć wartości swoich definicji.

Answer 4

Nie ma potrzeby korzystania z poleceń \cond i \endcond. Można ukryć inicjator po prostu za pomocą komendy \hideinitializer:

#define SOME_CONSTANT 1234 /**< An explanation @hideinitializer */ 

Jeśli chodzi o pierwsze pytanie, można ustawić HIDE_UNDOC_MEMBERS = YES i tylko makra posiadające blok dokumentację Doxygen zostanie pokazany na wyjściu.

Answer 5

Użytkownik chce tylko udokumentować zawartość zadeklarowaną w plikach .h. Zakładam, że deklarujesz wszystkie statyczne funkcje i zmienne jako static w swoich plikach .c. Wszystkie pozostałe są zadeklarowane również w odpowiednich plikach .h. To są twoi "publiczni" członkowie.

Co lubię robić w tym przypadku, i wierzę Doxygen był bardziej przeznaczony do stosowania w ten sposób jest:

• w Doxyfile ustaw EXTRACT_ALL = NO i dodać do katalogu gdzie .h pliki mają INPUT
• dodać /** \file */ do wszystkich swoich plików .h (ale nie do plików .c).

Spowoduje to zindeksowanie tylko zawartości zawartej w plikach .h.Można jeszcze dodać katalog zawierający swoje .c pliki INPUT w swojej Doxyfile i będą skanowane w poszukiwaniu dodatkowej dokumentacji dla swoich członków „publicznych” ...

Answer 6

I rozwiązać ten problem, przenosząc moją dokumentację z pliku .c do pliku .h. Następnie uruchom doxygen tylko w pliku .h.

Następnie przedmioty, które chcę udokumentować ("przedmioty publiczne") są wewnętrznie zbierane przez doksygen.

Ponieważ wcześniej ostrożnie umieszczałem "publiczne" elementy w pliku .h i "prywatne" w pliku .c, działa to bardzo dobrze.

Technika ta przyszła mi do głowy, gdy zauważyłem, że doxygen wciąga się w załączniki. Uderzyło mnie, że gdybym również przesunął podzbiór zawiera, że ​​moduł wywołujący musiałby użyć mojego modułu, to ta lista byłaby również udokumentowana.

Ta technika ma dodatkową zaletę: mogę umieścić dokumentację w jednym oknie terminala i źródło w innym oknie terminala podczas aktualizacji dokumentacji.