alexey.zholtikov/upm
1
0
Fork 0
mirror of https://github.com/eclipse/upm.git synced 2025-03-15 04:57:30 +03:00
Code Issues Actions Packages Projects Releases Wiki Activity

docs: minor adjustments to doxygen tag instructions

Browse Source 
Signed-off-by: Mihai Tudor Panu <mihai.tudor.panu@intel.com>
This commit is contained in:
Mihai Tudor Panu 2016-02-01 15:36:37 -08:00
parent 022b546003
commit 9d1afd35f8
1 changed files with 6 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
docs/documentation.md
View File

@ -50,10 +50,12 @@ Here's an example (disregard the "@verbatim" tags in your actual code):
library's "@defgroup", otherwise this is a new library name, generally the library's "@defgroup", otherwise this is a new library name, generally the
same as chip id. *Mandatory* 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. Must match
- `<component-name>` A short name for your sensor, can include manufacturer class name. *Mandatory*
name. *Mandatory* - `<component-name>` A short name for your sensor, try to avoid including the
- `<alt-name>` Alternative names that your sensor driver might have. *Optional* manufacturer's name here. *Mandatory*
- `<alt-name>` Alternative names that your sensor driver might have. This may
include manufacturer's name. *Optional*
- `<alt-id>` Alternative chip-ids that your sensor driver supports. *Optional* - `<alt-id>` Alternative chip-ids that your sensor driver supports. *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*