Cílem této práce je seznámit čtenáře s možnostmi dokumentace zdrojového kódu a blíže představit nástroj Doxygen. Řešení zahrnuje příručku použití softwaru Doxygen, šablony pro usnadnění procesu psaní a ukázkovou dokumentaci vytvořenou pro dříve existující projekt. Hlavní přínos je pro uživatele, kteří mají zájem začít používat, případně si rozšířit znalosti o nástroji Doxygen.
Annotation in English
The primary focus of this work is to inform the reader about possibilities in documenting source code and further introduce software called Doxygen. The practical part of thesis consists of manual for Doxygen software, templates to ease the process of writing and generated example of documentation for previously existing project. The main contribution of this thesis is for people who are starting to use, or want to expand their knowledge about Doxygen software.
Keywords
dokumentace, Doxygen, programovací jazyk C
Keywords in English
documentation, Doxygen, C programming language
Length of the covering note
52 s. (59 867 znaků)
Language
CZ
Annotation
Cílem této práce je seznámit čtenáře s možnostmi dokumentace zdrojového kódu a blíže představit nástroj Doxygen. Řešení zahrnuje příručku použití softwaru Doxygen, šablony pro usnadnění procesu psaní a ukázkovou dokumentaci vytvořenou pro dříve existující projekt. Hlavní přínos je pro uživatele, kteří mají zájem začít používat, případně si rozšířit znalosti o nástroji Doxygen.
Annotation in English
The primary focus of this work is to inform the reader about possibilities in documenting source code and further introduce software called Doxygen. The practical part of thesis consists of manual for Doxygen software, templates to ease the process of writing and generated example of documentation for previously existing project. The main contribution of this thesis is for people who are starting to use, or want to expand their knowledge about Doxygen software.
Keywords
dokumentace, Doxygen, programovací jazyk C
Keywords in English
documentation, Doxygen, C programming language
Research Plan
Zpracujte literární rešerši na téma dokumentace zdrojového kódu a příslušných nástrojů.
Popište nástroj Doxygen.
Navrhněte a vytvořte sadu zdrojových kódů v jazyce C, která bude demonstrovat možnosti nástroje Doxygen ke generování dokumentace z komentářů ve zdrojovém kódu.
Vytvořte příručku popisující postup použití nástroje Doxygen a přehled běžně používaných funkcí tohoto nástroje.
Vytvořte s využitím nástroje Doxygen ukázkovou dokumentaci pro navržené zdrojové kódy.
Research Plan
Zpracujte literární rešerši na téma dokumentace zdrojového kódu a příslušných nástrojů.
Popište nástroj Doxygen.
Navrhněte a vytvořte sadu zdrojových kódů v jazyce C, která bude demonstrovat možnosti nástroje Doxygen ke generování dokumentace z komentářů ve zdrojovém kódu.
Vytvořte příručku popisující postup použití nástroje Doxygen a přehled běžně používaných funkcí tohoto nástroje.
Vytvořte s využitím nástroje Doxygen ukázkovou dokumentaci pro navržené zdrojové kódy.
Recommended resources
BARR, Michael a Anthony J MASSA. Programming embedded systems: with C and GNU development tools. 2nd ed. Sebastopol: O'Reilly, 2006, xxi, 301 s. ISBN 978-0-596-00983-0.
CATSOULIS, John. Designing embedded hardware. 2nd ed. Sebastopol, CA: O\symbol{39}Reilly, 2005, xvi, 377 p. ISBN 0596007558.
MCCONNELL, Steve. Dokonalý kód: umění programování a techniky tvorby software. Vyd. 1. Brno: Computer Press, 2005, 894 s. ISBN 802510849x.
PINKER, Jiří. Mikroprocesory a mikropočítače. 1. vyd. Praha: BEN - technická literatura, 2004, 159 s. ISBN 80-7300-110-1.
Doxygen \matsymb{lbrack}online\matsymb{rbrack}. 2017 \matsymb{lbrack}cit. 2017-01-16\matsymb{rbrack}. Dostupné z: http://www.stack.nl/ dimitri/doxygen/index.html
Recommended resources
BARR, Michael a Anthony J MASSA. Programming embedded systems: with C and GNU development tools. 2nd ed. Sebastopol: O'Reilly, 2006, xxi, 301 s. ISBN 978-0-596-00983-0.
CATSOULIS, John. Designing embedded hardware. 2nd ed. Sebastopol, CA: O\symbol{39}Reilly, 2005, xvi, 377 p. ISBN 0596007558.
MCCONNELL, Steve. Dokonalý kód: umění programování a techniky tvorby software. Vyd. 1. Brno: Computer Press, 2005, 894 s. ISBN 802510849x.
PINKER, Jiří. Mikroprocesory a mikropočítače. 1. vyd. Praha: BEN - technická literatura, 2004, 159 s. ISBN 80-7300-110-1.
Doxygen \matsymb{lbrack}online\matsymb{rbrack}. 2017 \matsymb{lbrack}cit. 2017-01-16\matsymb{rbrack}. Dostupné z: http://www.stack.nl/ dimitri/doxygen/index.html
