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

sublime konzola

 

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.

sublime - package control
To, čo je pod SUBLIME TEXT 3 treba skopírovať 🙂

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

sublime - command pallete

Do okna napíšete:

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.

sublime - doxydoxygen

 

Keď si myslíte že dokumentácia je hotová, môžete si vyskúšať jej vygenerovanie. Otvorte terminál a zadajte:

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

4 thoughts on “Doxygen v Sublime – Quick tutorial

  1. Diky moc za tutorial, je to paradicka 😉

    Mam vsak este otazku – ako sa prejavia komentare tych prototypov funkcii v tej vygenerovanej HTML stranke? Skusal som to uz asi vsetkymi sposobmi (vratane toho ako to mas v poslednom obrazku tohto clanku) a nikde v tom vygenerovanom webe to neviem najst.

    1. Ahoj, tým si nie som istý ani ja. Mne sa však osvedčilo použiť @defgroup a @ingroup pri každej funkcii ako je popísané na nasledujúcom linku. Použiť ich máme v projekte takže asi toto bude riešením.

      Potom pribudne v meno položka Modules a jej výpis vyzerá približne nasledovne: doxygen - modules

      EDIT: Na skupine bolo napísané, že vraj stačí použiť @file aby sa zobrazil popis funkcii

  2. Zdravim….můžete mi poradit proč mi konzole vypisuje toto při pokusu o vytvoření toho html ???

    >>> doxygen Doxyfile
    File „“, line 1
    doxygen Doxyfile
    ^
    SyntaxError: unexpected EOF while parsing

    díky moc za pomoc….

    1. Ahoj, predpokladám že si to zadal do konzoly v Sublime, čo je chyba. Tento príkaz zadávaš do linuxového Terminálu (konzoly)

Pridaj komentár

Vaša e-mailová adresa nebude zverejnená. Vyžadované polia sú označené *