[każdy język]Doxygen - wprowadzenie
: niedziela 02 kwie 2017, 22:49
Doxygen – do czego on służy – jest to program, który na odstawie naszego kodu źródłowego wygeneruje nam dokumentację biblioteki/projektu. Oczywiście nie jest tak, że zrobi to z niczego – komentarze musimy pisać w specjalny sposób/korzystając ze specjalnej składni. Informacje na ten temat można znaleźć np. tu: https://www.stack.nl/~dimitri/doxygen/m ... locks.html
Wygenerowana dokumentacja może być w formie dokumentu HTML, lub LATEXA. HTML jest o tyle fajny, ze można to sobie wrzucić na stonkę (lub na gita – to też przedstawię) i będzie dostępna online. Tutaj moja pierwsza taka dokumentacja (obecnie w wersji beta :p ) https://dambo1993.github.io/universal_l ... index.html
Więc każdy może wejść i zobaczyć, czy taka forma dokumentacji mu odpowiada.
Generalnie doxygena trzeba pobrać i wygenerowanie takiej dokumentacji zajmuje trochę klikania… lub jak ktoś jest leniwy – można wgrać plugin do środowisk opartych na Eclipse i mieć to mega ładnie wbudowane. Ten plugin nosi nazwę Eclox – pobieramy go z Eclipse marketu:
Wgrywamy i po restarcie mamy dodatkowa ikonka:
Do projektu mozme teraz dodać plik typu Doxygen:
Klikamy na niego dwukrotnie i zmieniamy ustawienia na takie jakie potrzebujemy (ja zastosowałem jak na screenie):
Teraz za pomocą nowej ikonki wygenerujmy pliki, pojawią się w scieżce wskazanej w pliku ustawień. Dla htmla otrzymamy folder „html” z plikami w środku, możemy go podejrzeć w przeglądarce/Eclipsie.
Fajną opcją jest, ze Eclipse moz nam tworzyć szablony komentarzy doxygena. Tzn ustawiamy kursor nad funkcję wpisujemy „/**” i wciskamy enter. Utworzy się nagłówek z nazwami zmiennych pobranymi z funkcji niżej, my tylko uzupełniamy co one robią. Niestety domyślnie jest to wyłączone, aby uruchomić robimy tak:
Ostatnia kwestia – jak to wrzucić na gita. W internecie jest wieeele poradników na ten temat, przerobiłem 3 i nie działało. Każdy kombinuje z gałęziami w projekcie i innymi cudami. Widocznie od niedawna jest prostsza opcja. W głównym katalogu repozytorium musimy mieć katalog „docs”, a w nim pliki wygenerowane z Doxygena (wersja html). Teraz przechodzimy do ustawień gita na stronce i zaznaczamy jak na screenie:
Na górze pojawi się wtedy nasz adres – musimy do niego dopisać index.html i tam znajduje się dokumentacja. Mega proste
Jakieś błędy w opisie/sugestie itp? śmiało pisać!
Wygenerowana dokumentacja może być w formie dokumentu HTML, lub LATEXA. HTML jest o tyle fajny, ze można to sobie wrzucić na stonkę (lub na gita – to też przedstawię) i będzie dostępna online. Tutaj moja pierwsza taka dokumentacja (obecnie w wersji beta :p ) https://dambo1993.github.io/universal_l ... index.html
Więc każdy może wejść i zobaczyć, czy taka forma dokumentacji mu odpowiada.
Generalnie doxygena trzeba pobrać i wygenerowanie takiej dokumentacji zajmuje trochę klikania… lub jak ktoś jest leniwy – można wgrać plugin do środowisk opartych na Eclipse i mieć to mega ładnie wbudowane. Ten plugin nosi nazwę Eclox – pobieramy go z Eclipse marketu:
Wgrywamy i po restarcie mamy dodatkowa ikonka:
Do projektu mozme teraz dodać plik typu Doxygen:
Klikamy na niego dwukrotnie i zmieniamy ustawienia na takie jakie potrzebujemy (ja zastosowałem jak na screenie):
Teraz za pomocą nowej ikonki wygenerujmy pliki, pojawią się w scieżce wskazanej w pliku ustawień. Dla htmla otrzymamy folder „html” z plikami w środku, możemy go podejrzeć w przeglądarce/Eclipsie.
Fajną opcją jest, ze Eclipse moz nam tworzyć szablony komentarzy doxygena. Tzn ustawiamy kursor nad funkcję wpisujemy „/**” i wciskamy enter. Utworzy się nagłówek z nazwami zmiennych pobranymi z funkcji niżej, my tylko uzupełniamy co one robią. Niestety domyślnie jest to wyłączone, aby uruchomić robimy tak:
Ostatnia kwestia – jak to wrzucić na gita. W internecie jest wieeele poradników na ten temat, przerobiłem 3 i nie działało. Każdy kombinuje z gałęziami w projekcie i innymi cudami. Widocznie od niedawna jest prostsza opcja. W głównym katalogu repozytorium musimy mieć katalog „docs”, a w nim pliki wygenerowane z Doxygena (wersja html). Teraz przechodzimy do ustawień gita na stronce i zaznaczamy jak na screenie:
Na górze pojawi się wtedy nasz adres – musimy do niego dopisać index.html i tam znajduje się dokumentacja. Mega proste
Jakieś błędy w opisie/sugestie itp? śmiało pisać!