Browse Source

docs: added optional @web tag for sensor links

Signed-off-by: Mihai Tudor Panu <mihai.tudor.panu@intel.com>
Mihai Tudor Panu 10 years ago
parent
commit
1792eb9cfe
1 changed files with 2 additions and 0 deletions
  1. 2
    0
      docs/documentation.md

+ 2
- 0
docs/documentation.md View File

@@ -29,6 +29,7 @@ Here's an example (disregard the "@verbatim" tags in your actual code):
29 29
  * @altname <alt-name>
30 30
  * @type <component-category>
31 31
  * @man <component-manufacturer>
32
+ * @web <component-weblinks>
32 33
  * @con <connection-type>
33 34
  * @kit <component-kit>
34 35
  *
@@ -55,6 +56,7 @@ Here's an example (disregard the "@verbatim" tags in your actual code):
55 56
 - `<component-category>` Mention one or more categories the sensor fits in. Can
56 57
   be 'other'. *Mandatory*
57 58
 - `<component-manufacturer>` Sensor manufacturer. Can be 'generic'. *Mandatory*
59
+- `<component-weblinks>` Links to vendors or data-sheets. *Optional*
58 60
 - `<connection-type>` Specifies how does the sensor connect to the board
59 61
   *Mandatory*
60 62
 - `<component-kit>` Specifies if the sensor is part of a kit. *Optional*