mirror of
https://github.com/eclipse/upm.git
synced 2025-03-15 04:57:30 +03:00
doxygen: new @altid tag for sensors supporting multiple chip variants
Signed-off-by: Mihai Tudor Panu <mihai.tudor.panu@intel.com>
This commit is contained in:
parent
3ed6e09f20
commit
0f015354ef
@ -28,6 +28,7 @@ Here's an example (disregard the "@verbatim" tags in your actual code):
|
|||||||
* @sensor <chip-id>
|
* @sensor <chip-id>
|
||||||
* @comname <component-name>
|
* @comname <component-name>
|
||||||
* @altname <alt-name>
|
* @altname <alt-name>
|
||||||
|
* @altid <alt-id>
|
||||||
* @type <component-category>
|
* @type <component-category>
|
||||||
* @man <component-manufacturer>
|
* @man <component-manufacturer>
|
||||||
* @web <component-weblinks>
|
* @web <component-weblinks>
|
||||||
@ -52,8 +53,8 @@ Here's an example (disregard the "@verbatim" tags in your actual code):
|
|||||||
available or relevant, use a unique descriptor that makes sense. *Mandatory*
|
available or relevant, use a unique descriptor that makes sense. *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
|
- `<alt-name>` Alternative names that your sensor driver might have. *Optional*
|
||||||
have or support respectively. *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*
|
||||||
- `<component-manufacturer>` Sensor manufacturer. Can be 'generic'. *Mandatory*
|
- `<component-manufacturer>` Sensor manufacturer. Can be 'generic'. *Mandatory*
|
||||||
|
@ -236,6 +236,7 @@ ALIASES = library="@ingroup " \
|
|||||||
sensor="@li **ID:** " \
|
sensor="@li **ID:** " \
|
||||||
comname="@li **Name:** " \
|
comname="@li **Name:** " \
|
||||||
altname="@li **Other Names:** " \
|
altname="@li **Other Names:** " \
|
||||||
|
altid="@li **Other Chips:** " \
|
||||||
type="@li **Category:** " \
|
type="@li **Category:** " \
|
||||||
man="@li **Manufacturer:** " \
|
man="@li **Manufacturer:** " \
|
||||||
web="@li **Link:** " \
|
web="@li **Link:** " \
|
||||||
|
Loading…
x
Reference in New Issue
Block a user