diff --git a/Doxyfile.in b/Doxyfile.in index 8f372010..04ea10b1 100644 --- a/Doxyfile.in +++ b/Doxyfile.in @@ -232,7 +232,14 @@ TAB_SIZE = 4 # "Side Effects:". You can put \n's in the value part of an alias to insert # newlines. -ALIASES = +ALIASES = library="@ingroup " \ + sensor="@li **ID:** " \ + comname="@li **Name:** " \ + altname="@li **Other Names:** " \ + type="@li **Category:** " \ + man="@li **Manufacturer:** " \ + kit="@li **Kit:** " \ + con="@li **Connection:** " \ # This tag can be used to specify a number of word-keyword mappings (TCL only). # A mapping has the form "name=value". For example adding "class=itcl::class" diff --git a/docs/documentation.md b/docs/documentation.md index 19264141..15810ea8 100644 --- a/docs/documentation.md +++ b/docs/documentation.md @@ -23,13 +23,14 @@ Here's an example (disregard the "@verbatim" tags in your actual code): ``` @verbatim /** - * @sensor * @library - * @name - * @category - * @manufacturer + * @sensor + * @comname + * @altname + * @type + * @man + * @con * @kit - * @connection * * @brief Short class/sensor description * @@ -42,19 +43,21 @@ Here's an example (disregard the "@verbatim" tags in your actual code): @endverbatim ``` +- `` When adding to an existing library this needs to match that + library's "@defgroup", otherwise this is a new library name, generally the + same as chip id. *Mandatory* - `` Usually the chip number used by the sensor. When this is not available or relevant, use a unique descriptor that makes sense. *Mandatory* -- `` When adding to an existing library this needs to match that - library's "@defgroup", otherwise this is generally the same as chip id. - *Mandatory* - `` A short name for your sensor, can include manufacturer name. *Mandatory* +- `` Alternative names or chip-ids that your sensor driver might + have or support respectively. *Optional* - `` Mention one or more categories the sensor fits in. Can be 'other'. *Mandatory* -- `` Sensor manufacturer. Can be 'generic'. *Mandatory* -- `` Specifies if the sensor is part of a kit. *Optional* +- `` Sensor manufacturer. Can be 'generic'. *Mandatory* - `` Specifies how does the sensor connect to the board *Mandatory* +- `` Specifies if the sensor is part of a kit. *Optional* Existing groups that can be used for the manufacturer, connection, category and kit tags are found in the src/upm.h file.