Oddzielna "wewnętrzna" dokumentacja "zewnętrzna" w doxygen

Question

Chcę udokumentować bibliotekę z doxygen. Dokumentacja zostanie odczytana przez dwie klasy ludzi: użytkowników, którzy są zainteresowani tylko zewnętrznym API i programistami, którzy chcą zobaczyć dokumentację dla wszystkich funkcji/struktur.

Chciałbym użyć do oddzielenia plików doxy w celu utworzenia dokumentacji. Czy istnieje "tag", który mogę umieścić w bloku komentarza, aby oznaczyć komentarz jako wewnętrzny/zewnętrzny?

Answer 1

Set INTERNAL_DOCS:

# The INTERNAL_DOCS tag determines if documentation 
# that is typed after a \internal command is included. If the tag is set 
# to NO (the default) then the documentation will be excluded. 
# Set it to YES to include the internal documentation. 

INTERNAL_DOCS   = NO 

W dokumentacji można użyć \internal lub @internal bez względu na ziarnistość chcesz (plik, funkcja, itd.).

Answer 2

Polecenie \ dyr:

\internal (@internal) ma tylko ziarnistość dla bieżącego komentarza bloku. Nie pozwala Ci żaden sposób ukryć definicję struktury w C

Najprostszym sposobem, aby to zrobić, to umieścić

\ dyr WEWNĘTRZNEJ

w górnej części wewnętrznej pliku nagłówka i

\ endcond

u dołu. Następnie w pliku konfiguracyjnym, dodać

ENABLED_SECTIONS = WEWNĘTRZNY

aby umożliwić wewnętrzne elementy, które należy uwzględnić w dokumentacji.

Ten sposób jest również zalecany przez użytkowników Doxygen, np. here

Answer 3

Jest to proste rozwiązanie, które wykorzystuje fakt, że zazwyczaj można rozróżnić wewnętrzne i zewnętrzne części kodu na pliki.

można po prostu ograniczyć plików wejściowych tylko do tych plików nagłówkowych, które chcesz wystawiać w dokumentacji zewnętrznej:

# For internal, we parse all files 
INPUT = ./ 
# For external, we parse only the files containing the public interface 
INPUT = include/header1.hpp include/header2.hpp 

Ma to tę zaletę, że pliki źródłowe nie muszą być modyfikowane (z \internal lub @internal).