/ Tipy a Triky

Doxygen v Sublime – Quick tutorial

Súčasťou posledného projektu je generovanie dokumentácie projektu v Doxygen. Nakoľko však democviko bude pravdepodobne znova zverejnené až po termíne odovzdania, rozhodol som sa vypracovať tento rýchly tutoriál pre všetkých ktorý majú problém nejako začať s touto „triviálni“ úlohou 🙂

Po pravde ono je to naozaj jednoduché, len treba využiť ten správny editor a doplnok.

Čo teda budete potrebovať?

  • približne 5 min času na konfiguráciu
  • Sublime Text 3
  • najlepšie Linux

Ako nainštalovať Sublime snáď netreba vysvetľovať. To zvládne určite každý aj bez tutoriálu.

Keď máte nainštalovaný Sublime, zvolte View > Show console. V spodnej časi vám vyskočí konzola
Selection_069

Potom prejdite na stránku http://packagecontrol.io a v menu na pravo zvoľte Installation. Zobrazí sa vám nasledujúci kód, ktorý skopírujete do konzoly, ktorú ste si zobrazili vyšie a stlačte Enter.
Selection_070

Sublime následne reštartujte a možno sa ešte bude chcieť pár krát reštartovať sám, tak mu to umožnite. Keď všetko prebehne v poriadku, zrušte konzolu (ak sa už nevypla sama) klávesou Esc a použite klávesovú skratku Ctrl + Shift + P po ktorej sa zobrazí nasledujúce okno
Workspace-1_073_compressed

Do okna teraz napíšte:

package install

stlačíte Enter a následne zadajte:

DoxyDoxygen

Zvolte prvý balík, ktorý sa vám zobrazí a po chvíli máte úspešne nainštalovaný doplnok v Sublime. Vyskočí stránka s dokumentáciou, tak si ju pozrite.

Asi najdôležitejší príkaz je: /** + Enter.

Skrátka napíšete vrchnú časť značky pre komentár a stlačíte Enter. DoxyDoxygen už vygeneruje potrebnú kostru, ktorú vy už len vyplníte.
Workspace-1_078_compressed

doxygen Doxyfile

Príkaz vygeneruje priečinok html/

Teraz stačí najsť súbor index.html a otvoriť ho v prehliadači, alebo použiť príkaz:

firefox index.html

Záverom:

  • Kostra, ktorú vygeneruje DoxyDoxygen nemusí obsahovať všetko čo je v zadaní tak na to nezabudnite
  • Odovzdáva sa hlavičkový súbor Proj3.h a nie samotná dokumentácia
  • Konfiguračný súbor Doxyfile si viete stiahnúť na Wiki v popise projektu