Operacja generowania dokumentacji polega na wywołaniu programu doxygen z jedną opcją - nazwą pliku konfiguracyjnego.
Generowanie tego pliku można sobie ułatwić przez użycie programu doxywizard. Uruchamia się go pod X-ami. Umożliwia wygodne ustawienie wszystkich potrzebnych opcji za pomocą klikanego interfejsu. Najważniejsze jest podanie katalogu, w którym znajdują się pliki z kodem. Można kazać generować dokumentację dla wszystkich plików o podanej masce, lub o konkretnych nazwach. Ważne jest zaznaczenie opcji EXTRACT_ALL, dzięki czemu zostanie wygenerowany opis także tych funkcji, które nie są opisane komentarzami. Należy także zaznaczyć, jakich formatów danych wyjściowych się spodziewamy i w jakich katalogach mają być wygenerowane.
Po ustawieniu opcji każemy zapisać plik konfiguracyjny na dysku, a potem możemy go używać jako parametru dla programu Doxygen. Uwaga! W niektórych wersjach Doxygena (np. 1.2.8.1) program doxywizard miał błąd, objawiający się niezapisywaniem do wyjściowego pliku prawidłowej wartości opcji EXTRACT_ALL. Konieczna jest wtedy ręczna edycja pliku konfiguracyjnego i ustawienie jej wartości na YES.
Poprzedni | Spis treści | Następny |
Komentowanie kodu | Początek rozdziału | Przeszukiwanie dokumentacji - system ht://Dig |