Browse Source

docs: prevented doxygen tag name clash and added aliases

Signed-off-by: Mihai Tudor Panu <mihai.tudor.panu@intel.com>
Mihai Tudor Panu 10 years ago
parent
commit
10d1975bc2
2 changed files with 21 additions and 11 deletions
  1. 8
    1
      Doxyfile.in
  2. 13
    10
      docs/documentation.md

+ 8
- 1
Doxyfile.in View File

@@ -232,7 +232,14 @@ TAB_SIZE               = 4
232 232
 # "Side Effects:". You can put \n's in the value part of an alias to insert
233 233
 # newlines.
234 234
 
235
-ALIASES                =
235
+ALIASES                = library="@ingroup " \
236
+                         sensor="@li **ID:** " \
237
+                         comname="@li **Name:** " \
238
+                         altname="@li **Other Names:** " \
239
+                         type="@li **Category:** " \
240
+                         man="@li **Manufacturer:** " \
241
+                         kit="@li **Kit:** " \
242
+                         con="@li **Connection:** " \
236 243
 
237 244
 # This tag can be used to specify a number of word-keyword mappings (TCL only).
238 245
 # A mapping has the form "name=value". For example adding "class=itcl::class"

+ 13
- 10
docs/documentation.md View File

@@ -23,13 +23,14 @@ Here's an example (disregard the "@verbatim" tags in your actual code):
23 23
 ```
24 24
 @verbatim
25 25
 /**
26
- * @sensor <chip-id>
27 26
  * @library <lib-name>
28
- * @name <component-name>
29
- * @category <component-category>
30
- * @manufacturer <component-man>
27
+ * @sensor <chip-id>
28
+ * @comname <component-name>
29
+ * @altname <alt-name>
30
+ * @type <component-category>
31
+ * @man <component-manufacturer>
32
+ * @con <connection-type>
31 33
  * @kit <component-kit>
32
- * @connection <connection-type>
33 34
  *
34 35
  * @brief Short class/sensor description
35 36
  * 
@@ -42,19 +43,21 @@ Here's an example (disregard the "@verbatim" tags in your actual code):
42 43
 @endverbatim
43 44
 ```
44 45
 
46
+- `<lib-name>` When adding to an existing library this needs to match that
47
+  library's "@defgroup", otherwise this is a new library name, generally the
48
+  same as chip id. *Mandatory*
45 49
 - `<chip-id>` Usually the chip number used by the sensor. When this is not
46 50
   available or relevant, use a unique descriptor that makes sense. *Mandatory*
47
-- `<lib-name>` When adding to an existing library this needs to match that
48
-  library's "@defgroup", otherwise this is generally the same as chip id.
49
-  *Mandatory*
50 51
 - `<component-name>` A short name for your sensor, can include manufacturer
51 52
   name. *Mandatory*
53
+- `<alt-name>` Alternative names or chip-ids that your sensor driver might
54
+  have or support respectively. *Optional*
52 55
 - `<component-category>` Mention one or more categories the sensor fits in. Can
53 56
   be 'other'. *Mandatory*
54
-- `<component-man>` Sensor manufacturer. Can be 'generic'. *Mandatory*
55
-- `<component-kit>` Specifies if the sensor is part of a kit. *Optional*
57
+- `<component-manufacturer>` Sensor manufacturer. Can be 'generic'. *Mandatory*
56 58
 - `<connection-type>` Specifies how does the sensor connect to the board
57 59
   *Mandatory*
60
+- `<component-kit>` Specifies if the sensor is part of a kit. *Optional*
58 61
 
59 62
 Existing groups that can be used for the manufacturer, connection, category and
60 63
 kit tags are found in the src/upm.h file.