minor doxygen updates

This commit is contained in:
Felix Ruess
2012-01-19 18:54:05 +01:00
parent 7e6b75bead
commit fb52967c1e
2 changed files with 7 additions and 5 deletions
+3 -3
View File
@@ -25,19 +25,19 @@ DOXYFILE_ENCODING = UTF-8
# The PROJECT_NAME tag is a single word (or a sequence of words surrounded
# by quotes) that should identify the project.
PROJECT_NAME = "Paparazzi UAV"
PROJECT_NAME = "Paparazzi UAS"
# The PROJECT_NUMBER tag can be used to enter a project or revision number.
# This could be handy for archiving the generated documentation or
# if some version control system is used.
PROJECT_NUMBER = 3.5
PROJECT_NUMBER =
# Using the PROJECT_BRIEF tag one can provide an optional one line description
# for a project that appears at the top of each page and should give viewer
# a quick idea about the purpose of the project. Keep the description short.
PROJECT_BRIEF = "Paparazzi is a free software Unmanned (Air) Vehicle System."
PROJECT_BRIEF = "Paparazzi is a free software Unmanned Aircraft System."
# With the PROJECT_LOGO tag one can specify an logo or icon that is
# included in the documentation. The maximum height of the logo should not
+4 -2
View File
@@ -107,7 +107,7 @@ comments.
-# for documentation requiring multiple lines, use a "block" style:
@verbatim
/**
* @brief First sentence is short description. Remaining text becomes
* First sentence is brief description. Remaining text becomes
* the full description block, where "empty" lines start new paragraphs.
*
* One can make text appear in @a italics, @b bold, @c monospace, or
@@ -139,7 +139,7 @@ int field2; ///< a brief description
@verbatim
/**
* @file foo/bar/file.c
* @brief Brief description of file.
* Brief description of file.
*
* More detailed description of file.
*/
@@ -150,6 +150,8 @@ int field2; ///< a brief description
The following guidelines apply to all Doxygen comment blocks:
-# Use the @c '\@cmd' form for all doxygen commands (do @b not use @c '\\cmd').
-# It is not necessary to use @c \@brief since @c JAVADOC_AUTOBRIEF is enabled.
- The first line (until the first dot) is automatically treated as brief description.
-# Use symbol names such that Doxygen automatically creates links:
-# @c function_name() can be used to reference functions
(e.g. ahrs_propagate()).