Doxygen

Doksidžen
Programer(i)	Dimitri van Hiš
Prvo izdanje	26. oktobar 1997.; pre 27 godina
Stabilno izdanje	1.8.15 / 27. decembar 2018.; pre 5 godina
Repozitorijum	github.com/doxygen/doxygen;
Operativni sistem	Linuks, Windows, Mac OS, Solaris
Tip	Generator dokumentacije
Licenca	GNU OJL
Veb-sajt	www.doxygen.org

Doksidžen je program za automatsku dokumentaciju programskog koda^[3] za C++, C, Javu, Objektni C, Pajton, IDL i u izvjesnoj mjeri za PHP, C#, D i ActionScript. Postoje verzije Doksidžena za većinu uniksolikih sistema, kao i za Windows i Mac OS. Autor najvećeg dijela programa je Dimitri van Hiš (hol. Dimitri van Heesch).

Upotreba

Da bi Doksidžen obavio automatsko dokumentovanje određenog programskog koda, potrebno je prije deklaracija promjenljivih, funkcija i klasa postaviti posebno označene komentare, koristeći Doksidženovu sintaksu. Doksidžen je zapravo naslijedio sintaksu iz Javadoka i Qt-a, što ga čini dodatno pogodnim za korisnike koji su navikli na neke od ovih paketa.

Označavanje

Moguće je koristiti sljedeće načine označavanja Doksidženovih komentara:

Ceovske komentare /* ... */, ali sa dvije zvjezdice na početku:

/** ово је коментар који Доксиџен разумије */

Ceplusplusovske linijske komentare, ali sa tri kose crte na početku:

/// И ово је коментар који Доксиџен разумије

Ako određeni komentar, označen na neki od spomenutih načina, prethodi deklaraciji klase, funkcije ili promjenljive, Doksidžen će shvatiti taj komentar kao opis te programske cjeline i prikazati ga uz tu klasu, funkciju ili promjenljivu u novoj dokumentaciji.

Posebne oznake

U okviru Doksidženovih komentara moguće je koristiti posebne oznake, označene obrnutom kosom crtom (\), da bi se označio dio programske cjeline koja se objašnjava. Slijede osnovna od ovih posebnih oznaka:

\param imePromjenljive OPIS - oznaka da OPIS predstavlja opis argumenta funkcije imePromjenljive
\return OPIS - oznaka da OPIS predstavlja opis rezultata funkcije
\author IME - oznaka da IME predstavlja ime autora ovog dijela programa
\brief KRATAK_OPIS - oznaka da KRATAK_OPIS predstavlja kratak opis narednog dijela programa
latex] <ime datoteke> „OPIS“ - ubacuje sliku u dokumentaciju, na osnovu date datoteke, uz opis „OPIS“
\mainpage TEKST - oznaka koja kaže da TEKST treba da ide na početnu stranicu dokumentacije

Generisanje dokumentacije

Da bi se pristupilo stvaranju dokumentacije, potrebno je napraviti datoteku proizvoljnog imena i ekstenzije cfg, koristeći program Doksidžen. Ta datoteka sadrži podrazumijevana detaljna podešavanja procesa dokumentacije, i moguće ju je prilagoditi svojim potrebama prije nego što se pokrene proces automatskog stvaranja dokumentacije.

Doksidžen može da generiše dokumentaciju u formatima HTML, CHM, RTF, PDF, Lateh, Postskript i u obliku Uniksovih „man“ strana. Kada je konfiguraciona datoteka spremna, komandom doxygen sa tom datotekom kao argumentom komandne linije se generiše kompletna dokumentacija.

Primjer

Naredni primjer prikazuje programski kod na jeziku C++, spreman za automatsko generisanje dokumentacije

/**
  * Класа Vrijeme представља један тренутак у времену.
  *
  * @author Петар Перић
  */
class Vrijeme {
   int brojMilisekundi;
   /**
     * Конструктор који иницијализује објекат на одређено вријеме
     * @param brojMilisekundi број милисекунди од 1. јануара 1970. до датог тренутка
     */
   Vrijeme(int brojMilisekundi): brojMilisekundi(brojMilisekundi)
   {}
 
   /**
     * Функција за добијање текућег времена
     * @return Објекат класе Vrijeme постављен на текуће вријеме
     */
   static Vrijeme sad()
   {
       return Vrijeme(1000 * time() );
   }
};

Vidi još

Javadok

Reference

^ ANNOUNCE: doxygen 0.1 Arhivirano oktobar 4, 2011 na sajtu Wayback Machine, Announcing: the first release of Doxygen, a C++ documentation system. , From: Dimitri van Heesch, Date: Sun, 26 Oct 1997, Qt-interest Archive
^ „Changelog”. Doxygen. 2018-12-27. Arhivirano iz originala 03. 08. 2019. g. Pristupljeno 2018-12-31.
^ „Doxygen - OpenComputing”. web.archive.org. 23. 11. 2015. Arhivirano iz originala 23. 11. 2015. g. Pristupljeno 03. 09. 2019. CS1 održavanje: Nepodoban URL (veza)

Spoljašnje veze

Zvanični veb-sajt

[1] ANNOUNCE: doxygen 0.1 Arhivirano oktobar 4, 2011 na sajtu Wayback Machine, Announcing: the first release of Doxygen, a C++ documentation system. , From: Dimitri van Heesch, Date: Sun, 26 Oct 1997, Qt-interest Archive

[2] „Changelog”. Doxygen. 2018-12-27. Arhivirano iz originala 03. 08. 2019. g. Pristupljeno 2018-12-31.

[3] „Doxygen - OpenComputing”. web.archive.org. 23. 11. 2015. Arhivirano iz originala 23. 11. 2015. g. Pristupljeno 03. 09. 2019. CS1 održavanje: Nepodoban URL (veza)

[1]

[2]

[3]