mirror of
https://github.com/eclipse/upm.git
synced 2025-03-15 04:57:30 +03:00
docs: prevented doxygen tag name clash and added aliases
Signed-off-by: Mihai Tudor Panu <mihai.tudor.panu@intel.com>
This commit is contained in:
parent
0aa3d59487
commit
10d1975bc2
@ -232,7 +232,14 @@ TAB_SIZE = 4
|
|||||||
# "Side Effects:". You can put \n's in the value part of an alias to insert
|
# "Side Effects:". You can put \n's in the value part of an alias to insert
|
||||||
# newlines.
|
# 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).
|
# 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"
|
# A mapping has the form "name=value". For example adding "class=itcl::class"
|
||||||
|
@ -23,13 +23,14 @@ Here's an example (disregard the "@verbatim" tags in your actual code):
|
|||||||
```
|
```
|
||||||
@verbatim
|
@verbatim
|
||||||
/**
|
/**
|
||||||
* @sensor <chip-id>
|
|
||||||
* @library <lib-name>
|
* @library <lib-name>
|
||||||
* @name <component-name>
|
* @sensor <chip-id>
|
||||||
* @category <component-category>
|
* @comname <component-name>
|
||||||
* @manufacturer <component-man>
|
* @altname <alt-name>
|
||||||
|
* @type <component-category>
|
||||||
|
* @man <component-manufacturer>
|
||||||
|
* @con <connection-type>
|
||||||
* @kit <component-kit>
|
* @kit <component-kit>
|
||||||
* @connection <connection-type>
|
|
||||||
*
|
*
|
||||||
* @brief Short class/sensor description
|
* @brief Short class/sensor description
|
||||||
*
|
*
|
||||||
@ -42,19 +43,21 @@ Here's an example (disregard the "@verbatim" tags in your actual code):
|
|||||||
@endverbatim
|
@endverbatim
|
||||||
```
|
```
|
||||||
|
|
||||||
|
- `<lib-name>` 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*
|
||||||
- `<chip-id>` Usually the chip number used by the sensor. When this is not
|
- `<chip-id>` Usually the chip number used by the sensor. When this is not
|
||||||
available or relevant, use a unique descriptor that makes sense. *Mandatory*
|
available or relevant, use a unique descriptor that makes sense. *Mandatory*
|
||||||
- `<lib-name>` When adding to an existing library this needs to match that
|
|
||||||
library's "@defgroup", otherwise this is generally the same as chip id.
|
|
||||||
*Mandatory*
|
|
||||||
- `<component-name>` A short name for your sensor, can include manufacturer
|
- `<component-name>` A short name for your sensor, can include manufacturer
|
||||||
name. *Mandatory*
|
name. *Mandatory*
|
||||||
|
- `<alt-name>` Alternative names or chip-ids that your sensor driver might
|
||||||
|
have or support respectively. *Optional*
|
||||||
- `<component-category>` Mention one or more categories the sensor fits in. Can
|
- `<component-category>` Mention one or more categories the sensor fits in. Can
|
||||||
be 'other'. *Mandatory*
|
be 'other'. *Mandatory*
|
||||||
- `<component-man>` Sensor manufacturer. Can be 'generic'. *Mandatory*
|
- `<component-manufacturer>` Sensor manufacturer. Can be 'generic'. *Mandatory*
|
||||||
- `<component-kit>` Specifies if the sensor is part of a kit. *Optional*
|
|
||||||
- `<connection-type>` Specifies how does the sensor connect to the board
|
- `<connection-type>` Specifies how does the sensor connect to the board
|
||||||
*Mandatory*
|
*Mandatory*
|
||||||
|
- `<component-kit>` Specifies if the sensor is part of a kit. *Optional*
|
||||||
|
|
||||||
Existing groups that can be used for the manufacturer, connection, category and
|
Existing groups that can be used for the manufacturer, connection, category and
|
||||||
kit tags are found in the src/upm.h file.
|
kit tags are found in the src/upm.h file.
|
||||||
|
Loading…
x
Reference in New Issue
Block a user