From a4e5648a1d8ce7e8c10ee4be16577871f3844506 Mon Sep 17 00:00:00 2001 From: tuxmaster Date: Wed, 2 Sep 2015 12:20:36 +0200 Subject: [PATCH] - Parameter der Funktionen sollten auch alle dokumentiert sein. --- Doxyfile | 12 ++++++------ Plug-Ins/Dummy/Quellen/Dummy.cpp | 2 ++ Plug-Ins/EM7345/Quellen/EM7345.cpp | 2 ++ 3 files changed, 10 insertions(+), 6 deletions(-) diff --git a/Doxyfile b/Doxyfile index c9ccd59..ce6dac1 100644 --- a/Doxyfile +++ b/Doxyfile @@ -68,7 +68,7 @@ OUTPUT_DIRECTORY = Dokumenation # performance problems for the file system. # The default value is: NO. -CREATE_SUBDIRS = YES +CREATE_SUBDIRS = NO # If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII # characters to appear in the names of generated files. If set to NO, non-ASCII @@ -76,7 +76,7 @@ CREATE_SUBDIRS = YES # U+3044. # The default value is: NO. -ALLOW_UNICODE_NAMES = YES +ALLOW_UNICODE_NAMES = NO # The OUTPUT_LANGUAGE tag is used to specify the language in which all # documentation generated by doxygen is written. Doxygen will use this @@ -343,7 +343,7 @@ SIP_SUPPORT = NO # should set this option to NO. # The default value is: YES. -IDL_PROPERTY_SUPPORT = NO +IDL_PROPERTY_SUPPORT = YES # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC # tag is set to YES then doxygen will reuse the documentation of the first @@ -740,7 +740,7 @@ WARN_IF_DOC_ERROR = YES # parameter documentation, but not about the absence of documentation. # The default value is: NO. -WARN_NO_PARAMDOC = NO +WARN_NO_PARAMDOC = YES # The WARN_FORMAT tag determines the format of the warning messages that doxygen # can produce. The string should contain the $file, $line, and $text tags, which @@ -2157,7 +2157,7 @@ HAVE_DOT = YES # Minimum value: 0, maximum value: 32, default value: 0. # This tag requires that the tag HAVE_DOT is set to YES. -DOT_NUM_THREADS = 0 +DOT_NUM_THREADS = 4 # When you want a differently looking font in the dot files that doxygen # generates you can specify the font name using DOT_FONTNAME. You need to make @@ -2313,7 +2313,7 @@ DOT_IMAGE_FORMAT = svg # The default value is: NO. # This tag requires that the tag HAVE_DOT is set to YES. -INTERACTIVE_SVG = NO +INTERACTIVE_SVG = YES # The DOT_PATH tag can be used to specify the path where the dot tool can be # found. If left blank, it is assumed the dot tool can be found in the path. diff --git a/Plug-Ins/Dummy/Quellen/Dummy.cpp b/Plug-Ins/Dummy/Quellen/Dummy.cpp index ba7cfa6..20d3bab 100644 --- a/Plug-Ins/Dummy/Quellen/Dummy.cpp +++ b/Plug-Ins/Dummy/Quellen/Dummy.cpp @@ -39,6 +39,7 @@ \brief Teilt der Steuerung mit, das neue Koordinaten empfangen worden sind. Die Übermittlung erfolgt als NMEA Datensatz. + \param[out] daten Der NMEA Datensatz. */ /*! @@ -46,6 +47,7 @@ \brief Teilt der Steuerung mit, wenn eine %Meldung vorliegt. Hierüber werden Debug-, Fehler- und Informationsmeldungen verschickt. + \param[out] meldung Die zu sendende %Meldung. */ /*! diff --git a/Plug-Ins/EM7345/Quellen/EM7345.cpp b/Plug-Ins/EM7345/Quellen/EM7345.cpp index ac2451d..a2b763a 100644 --- a/Plug-Ins/EM7345/Quellen/EM7345.cpp +++ b/Plug-Ins/EM7345/Quellen/EM7345.cpp @@ -43,6 +43,7 @@ \brief Teilt der Steuerung mit, das neue Koordinaten empfangen worden sind. Die Übermittlung erfolgt als NMEA Datensatz. + \param[out] daten Der NMEA Datensatz. */ /*! @@ -50,6 +51,7 @@ \brief Teilt der Steuerung mit, wenn eine %Meldung vorliegt. Hierüber werden Debug-, Fehler- und Informationsmeldungen verschickt. + \param[out] meldung Die zu sendende %Meldung. */ /*!