====== Doxygen ======
<box right 25% blue | **Doxygen**>
{{ .:doxygen_logo.png?170&nolink | Doxygen}}
----
  * [[http://www.stack.nl/~dimitri/doxygen/ | Projektwebseite]]
  * [[http://www.stack.nl/~dimitri/doxygen/download.html#srcbin | Download]]
  * [[http://www.stack.nl/~dimitri/doxygen/manual/index.html | Handbuch]]
</box>

Doxygen ist ein freies Software-Dokumentationswerkzeug für unterschiedliche Programmiersprachen. Dazu wird der Quellcode mit speziellen Kommentaren angereichert, aus welchen Doxygen dann eine übersichtliche Dokumentation erstellt. Als Ausgabeformat unterstützt Doxygen folgende Dateitypen:
  * HTML
  * CHM
  * LaTeX
  * XML
  * RTF
  * PostScript
  * PDF
  * Manpages
  * Markdown

===== Unterstützte Programmiersprachen =====

^ Vollständig            ^ Eingeschränkt  ^ Über zusätzliche Filter  ^
| [[..:C:start]]         | PHP            | Perl                     |
| [[..:Cpp:start | C++]] | C#             | Object Pascal            |
| Objective-C            | D              |                          |
| [[..:Java:start]]      | VHDL           |                          |
| Phython                | Tcl            |                          |
| Fortran                |                |                          |
| IDL                    |                |                          |

===== Einfaches Beispiel =====

<code c>
/**
 * \brief  Beispiel Funktion
 *
 *         Diese Funktion gibt den übergebenen Parameter
 *         auf der Konsole aus.
 *
 * \param      x   Auszugebender Parameter
 * \return         Status-Code
 *
 */
int foo(int x) {
    printf("Parameter: %d", x);
    return 0;
}
</code>

Beispiele aus der Praxis können im EEROS Robotics Framework nachgeschlagen werden. Beispielsweise die Klasse [[https://github.com/eeros-project/eeros-framework/blob/master/includes/eeros/control/Gain.hpp|Gain]] besitzt eine gute Dokumentaion mit Doxygen. 

===== Anleitungen und Links =====
  * [[Installation unter Windows]]
  * Installation unter Linux: (als root) ''apt-get install doxygen graphviz''
  * [[http://www.stack.nl/~dimitri/doxygen/manual/index.html | Offizielle Dokumentation (Englisch)]]
  * [[http://de.wikibooks.org/wiki/C%2B%2B-Programmierung:_Dokumentation_mit_Doxygen | C++-Programmierung: Dokumentation mit Doxygen (Wikibook, Deutsch)]]