alexey.zholtikov/upm
1
0
Fork 0
mirror of https://github.com/eclipse/upm.git synced 2025-07-01 17:31:13 +03:00
Code Issues Actions Packages Projects Releases Wiki Activity

docs: prevented doxygen tag name clash and added aliases

Browse Source 
Signed-off-by: Mihai Tudor Panu <mihai.tudor.panu@intel.com>
This commit is contained in:
Mihai Tudor Panu
2015-03-10 17:09:27 -07:00
parent 0aa3d59487
commit 10d1975bc2
2 changed files with 21 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

23
docs/documentation.md
View File

@ -23,13 +23,14 @@ Here's an example (disregard the "@verbatim" tags in your actual code):
```
@verbatim
/**
* @sensor <chip-id>
* @library <lib-name>
* @name <component-name>
* @category <component-category>
* @manufacturer <component-man>
* @sensor <chip-id>
* @comname <component-name>
* @altname <alt-name>
* @type <component-category>
* @man <component-manufacturer>
* @con <connection-type>
* @kit <component-kit>
* @connection <connection-type>
*
* @brief Short class/sensor description
*
@ -42,19 +43,21 @@ Here's an example (disregard the "@verbatim" tags in your actual code):
@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
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
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
be 'other'. *Mandatory*
- `<component-man>` Sensor manufacturer. Can be 'generic'. *Mandatory*
- `<component-kit>` Specifies if the sensor is part of a kit. *Optional*
- `<component-manufacturer>` Sensor manufacturer. Can be 'generic'. *Mandatory*
- `<connection-type>` Specifies how does the sensor connect to the board
*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
kit tags are found in the src/upm.h file.