HQEd Doxy

Cele projektu:

  • pobranie kodu źródłowego projektu HQEd z repozytorium kodu przy wykorzystaniu systemu kontroli wersji CVS
  • przetłumaczenie komentarzy z języka polskiego na angielski
  • poprawienie i ujednolicenie komentarzy kodu, tak aby były zgodne z wytycznymi programu do generowania dokumentacji Doxygen
  • integracja programu Doxygen z programem Graphviz służącym do tworzenia diagramów
  • wygenerowanie kompletnej dokumentacji projektu w formatach .html oraz .pdf

Sprawozdanie

Instalacja CVS:

W celu pobrania z repozytorium kodu aktualnej wersji projektu HQEd zainstalowaliśmy oprogramowanie CVS :

  1. dla Systemu Windows Smart CVS Version 7.1
  2. dla Systemu Linux (Ubuntu) Concurrent Versions System (CVS) 1.12.13

Konfiguracja CVS:

W celu uzyskania dostępu do repozytorium poprzez klienta CVS należało mieć dostęp do serwera KIRK. Kolejnym krokiem była jego konfiguracja. Opis konfiguracji programu wraz ze szczegółami znajduje się pod adresem: http://home.agh.edu.pl/~kk/doku.php?id=others:bimloq:start. W naszym projekcie korzystaliśmy z branchname: releases.

Instalacja Doxygen oraz DoxyWizard:

  1. Należy pobrać Doxygen ze strony: http://www.doxygen.org (w naszym przypadku była to wersja 1.7.5.1)
  2. Przy instalacji należy zatwierdzać zalecane ustawienia instalatora. Program zostanie zainstalowany w katalogu C:\Program Files\doxygen
  3. DoxyWizard jest automatycznie instalowany z Doxygen

Integracja Graphviza z Doxygen :

  1. Po włączeniu kreatora DoxyWizard wystarczy podać ścieżkę Grapviza tak jak na rysunku:

Generowanie Doxyfile

  1. Należy uruchomić kreator DoxyWizard,
  2. Następnie wypełniamy odpowiednia pola: ścieżkę dostępu do plików, ścieżkę pliku wyjściowego, nazwę projektu. Należy zaznaczyć pole Scan recursiveli w celu uwzględnienia podkatalogów,
  3. Następnie przechodzimy do zakładki EXPERT tam odznaczamy pole WARN_IF_UNDOCUMENTED,
  4. Na koniec przechodzimy do zakładki RUN, po naciśnięciu przycisku RUN DOXYGEN zostanie wygenerowana dokumentacja,

Przygotowanie kodu źródłowego do wygenerowania poprawnej dokumentacji

  1. Według założeń projektowych komentarze zostały przetłumaczone z języka polskiego na angielski,
  2. Należało w odpowiedni sposób przygotować komentarze według zasad komentowania doxygen, informacje na temat zasad znajdują się na stronie: http://home.agh.edu.pl/~kk/doku.php?id=others:bimloq:start

Dokumentacja doxygen HTML

Poniżej znajdują się obrazy z poprawnie wygenerowanej dokumentacji w postaci strony HTML:

  • Main Page

  • Class List

  • Class Index

  • Przykładowa klasa ARD_Level

  • Przykładowa klasa ardGraphixScene

Dokumentacja doxygen tex/pdf

Poniżej znajdują się obrazy z poprawnie wygenerowanej dokumentacji w postaci pliku pdf:

  • Opis Projektu

  • Przykładowa klasa

Wnioski oraz problemy napotkane przy realizacji projektu

  • Ręczna konfiguracja doxyfile jest czasochłonna, najlepszym rozwiązaniem jest korzystanie z kreatora DoxyWizard - narzędzie jest intuicyjne oraz przejrzyste dla użytkownika,
  • W celu poprawy błędów w komentarzach należy korzystać z QtCreatora zamiast Notatnika, pozwoli to na przyśpieszeniu pracy nad projektem oraz uniknięciu możliwych błędów wynikających z błędnej nawigacji po kodzie źródłowym,
  • Przy użyciu DoxyWizard w systemie Windows dokumentacje zostały wygenerowane poprawnie, pierwotnie przy generowaniu dokumentacji w systemie Linux oraz ręcznej konfiguracji, dokumentacje zostały wygenerowane niepoprawnie przykładowo: brak opisów niektórych klas etc.
pl/dydaktyka/miw/2011/hqeddoxy.txt · ostatnio zmienione: 2017/07/17 08:08 (edycja zewnętrzna)
www.chimeric.de Valid CSS Driven by DokuWiki do yourself a favour and use a real browser - get firefox!! Recent changes RSS feed Valid XHTML 1.0