doxygen
Rozdíly
Zde můžete vidět rozdíly mezi vybranou verzí a aktuální verzí dané stránky.
| Obě strany předchozí revizePředchozí verzeNásledující verze | Předchozí verze | ||
| doxygen [2016/07/22 14:19] – djbuldog | doxygen [2025/08/28 10:09] (aktuální) – upraveno mimo DokuWiki 127.0.0.1 | ||
|---|---|---|---|
| Řádek 21: | Řádek 21: | ||
| </ | </ | ||
| - | * nebo vygenerování ukázkového | + | * nebo vygenerovat |
| < | < | ||
| Řádek 27: | Řádek 27: | ||
| </ | </ | ||
| - | ==== syntax ve zdrojovém kódu ==== | + | ==== Základní úprava konfiguračního souboru |
| - | * http://www.jiggerjuice.net/ | + | |
| - | * komentáře na které má doxygen reagovat se identifikují pomocí: | + | * nastavit základní info o projektu |
| - | | + | |
| - | * všechny následující parametry se používají právě uvnitř tohoto komentáře | + | < |
| + | PROJECT_NAME | ||
| + | PROJECT_NUMBER | ||
| + | </code> | ||
| + | |||
| + | * nastavit výstupní adresář | ||
| + | |||
| + | < | ||
| + | OUTPUT_DIRECTORY | ||
| + | </code> | ||
| + | |||
| + | * nastavit cestu ke zdrojovým souborům | ||
| + | |||
| + | < | ||
| + | INPUT = " | ||
| + | </ | ||
| + | |||
| + | * 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ý, 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 | * 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ě) | * (lze psát \slovo (doporučeno vedoucím DP) i @slovo používané v javě) | ||
| Řádek 54: | Řádek 81: | ||
| </ | </ | ||
| - | === funkce | + | === Funkce |
| * @brief Description of the function | * @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 | * @brief directive, leave a blank line and add a detailed description of what the function does. Also add the following optional | ||
| Řádek 71: | Řádek 98: | ||
| </ | </ | ||
| - | === proměnné a struktury === | + | === Proměnné a struktury |
| + | |||
| + | ==== Main page ==== | ||
| + | * kromě automaticky generované dokumentace podporuje doxygen i extra dokumentaci přes .dox soubory | ||
doxygen.1469189945.txt.gz · Poslední úprava: (upraveno mimo DokuWiki)