Jak dołączyć folder do dokumentacji doxygen?

Question

Chcę dołączyć folder do dokumentacji doxygen.

Próbowałem \ strona i \ uwzględnij, ale to nie zadziałało, czy ktoś wie jak to zrobić? Oto drzewo:

Answer 1

Aby dodać komentarze do pytania, polecenie \ page doda strony do dokumentacji, którą napisałeś ręcznie. To znaczy. jeśli plik źródłowy zawiera \ deklarację strony, doda zawartość do indeksu dokumentacji. Możesz tutaj dodać dodatkową pomoc, na przykład:

/*! \page overviewpage Architecture Overview 
* 
* \section memorymanagement Memory Management 
* 
* Some writing you want to appear as a help page in the documentation here. 
*/ 

Polecenie \ include będzie zawierać kopię pliku jako blok kodu źródłowego.

Myślę, że faktycznie pytasz, w jaki sposób uzyskasz Doxygen, aby dodać wiele katalogów źródłowych. Tak długo jak ustawienie rekurencyjne jest TAK, co nie jest domyślne, powinno działać dobrze dla twojej struktury, jeśli ustawiłeś katalog główny jako wejście Doxygen.

RECURSIVE    = YES 

Jeśli nie, możesz dodać różne foldery, takie jak to, ze ścieżkami odnoszącymi się do pliku Doxyfile.

#--------------------------------------------------------------------------- 
# configuration options related to the input files 
#--------------------------------------------------------------------------- 

# The INPUT tag can be used to specify the files and/or directories that contain 
# documented source files. You may enter file names like "myfile.cpp" or 
# directories like "/usr/src/myproject". Separate the files or directories 
# with spaces. 

INPUT     = src test/src