Rozdíly

Zde můžete vidět rozdíly mezi vybranou verzí a aktuální verzí dané stránky.

--- doxygen [2013/12/29 19:34] – upraveno mimo DokuWiki 127.0.0.1
+++ doxygen [2025/08/28 10:09] (aktuální) – upraveno mimo DokuWiki 127.0.0.1
@@ Řádek 1: / Řádek 1: @@
+====== Doxygen ======
+  * slouží ke generování programátorské dokumentace.
+  * skládá se z
+    * doxygen - konzolová aplikace
+    * doxywizard - GUI frontend pro doxygen
+  * generování dokumentace se řídí konfiguračním souborem
 ==== Instalace ====
+  * nainstalování binárek
 <code>
-apt-get install doxygen-gui
+apt-get install doxygen doxygen-gui
 </code>
+  * spuštění průvodce (GUI)
 <code>
@@ Řádek 9: / Řádek 21: @@
 </code>
-==== syntax ve zdrojovém kódu ====
+  * nebo vygenerovat konfigurační soubor ručně
-  * http://www.jiggerjuice.net/software/doxygen.html
-  * komentáře na které má doxygen reagovat se identifikují pomocí: buď %%/**%% nebo %%//!%% (podle použitého komentáře)
+<code>
-     * funguje i %%/*!%% (doporučeno od vedoucího DP)
+doxygen -g mydoxy.cfg
-  * všechny následující parametry se používají právě uvnitř tohoto komentáře
+</code>
+==== Základní úprava konfiguračního souboru ====
+  * nastavit základní info o projektu
+<code>
+PROJECT_NAME           = "My Proj"
+PROJECT_NUMBER         = "1.0"
+</code>
+  * nastavit výstupní adresář
+<code>
+OUTPUT_DIRECTORY       = "doc"
+</code>
+  * nastavit cestu ke zdrojovým souborům
+<code>
+INPUT                  = "src"
+</code>
+  * vybrat si výstupní formát HTML, tex, xml, ...
+==== Doxygen komentáře zdrojových kódů ====
+  * aby se vygenerovala dokumentace k souboru, musí obsahovat doxygen hlavičku (nebo v cfg zapnout volbu extractall0
+  * komentáře na které má doxygen reagovat se identifikují pomocí:
+    * %%/**%% - víceřádkový, JavaDoc styl
+    * %%/*!%% - víceřádkový, Qt styl
+    * %%///%% - jednořádkový
+    * %%//!%% - jednořádkový
+=== Hlavička ===
-=== hlavička ===
   * na začátku zdrojáku lze specifikovat uvnitř komentáře následující klíčové slova
      * (lze psát \slovo (doporučeno vedoucím DP) i @slovo používané v javě)
@@ Řádek 36: / Řádek 81: @@
  </code>
-=== funkce ===
+=== Funkce ===
     * @brief Description of the function
     * @brief directive, leave a blank line and add a detailed description of what the function does. Also add the following optional
@@ Řádek 53: / Řádek 98: @@
  </code>
-=== proměnné a struktury ===
+=== Proměnné a struktury ===
+==== Main page ====
+  * kromě automaticky generované dokumentace podporuje doxygen i extra dokumentaci přes .dox soubory