Uruchamiaj Doxygen tylko w wybranych plikach/modułach?

Question

Ostatnio zacząłem pisać doxygen docs w istniejącym projekcie, który ma już sporo komentarzy doxygen.

Ponieważ trochę się uczę - lubię iterować z wprowadzaniem zmian i generowaniem dokumentów, ponieważ generowanie dokumentów jest dość powolne - 3-5 minut. To staje się niewykonalne.

Udało mi się usunąć większość plików z drzewa źródłowego, więc doxy tylko znalazło te, które edytowałem, ale jest to naprawdę okropne rozwiązanie, a nie coś, co chciałbym robić często.

Czy istnieje sposób (np. Zmienna arg argumentu lub env dla wiersza poleceń) - aby ograniczyć, które pliki/moduły są używane do generowania dokumentów - czy przebudowywanie dokumentów może być wykonywane o wiele szybciej?

Answer 1

Tak, możesz dostosować zachowanie Doxygen za pomocą wiersza poleceń lub zmiennych środowiskowych. Na przykład, jeśli chcesz tylko zawierać jeden plik (include/somefile.h), można wykonać Doxygen jak:

(cat Doxyfile ; echo "INPUT=include/somefile.h") | doxygen - 

zobaczyć Doxygen FAQ „s«Czy mogę skonfigurować doxygen z wiersza poleceń?» aby uzyskać więcej informacji o dostosowywaniu zachowań z wiersza poleceń.

Ewentualnie, jeśli chcesz używać zmiennych środowiskowych, można użyć określić coś jak następuje w pliku konfiguracyjnym:

INPUT = $(FILE) 

Doxygen wykonuje zmienną środowiskową podstawienie na swoich plikach konfiguracyjnych, co pozwala określić, który plik (e) należy działała na podstawie:

export FILE=include/somefile.h 
doxygen Doxyfile 

Zobacz Doxygen Configuration szczegółowe informacje o używaniu zmiennych środowiskowych w plikach konfiguracyjnych.