From 9d1afd35f87ab5a63d744b1991733cc19d58c04c Mon Sep 17 00:00:00 2001 From: Mihai Tudor Panu Date: Mon, 1 Feb 2016 15:36:37 -0800 Subject: [PATCH] docs: minor adjustments to doxygen tag instructions Signed-off-by: Mihai Tudor Panu --- docs/documentation.md | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/docs/documentation.md b/docs/documentation.md index e6377a7a..13712bbb 100644 --- a/docs/documentation.md +++ b/docs/documentation.md @@ -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 same as chip id. *Mandatory* - `` Usually the chip number used by the sensor. When this is not - available or relevant, use a unique descriptor that makes sense. *Mandatory* -- `` A short name for your sensor, can include manufacturer - name. *Mandatory* -- `` Alternative names that your sensor driver might have. *Optional* + available or relevant, use a unique descriptor that makes sense. Must match + class name. *Mandatory* +- `` A short name for your sensor, try to avoid including the + manufacturer's name here. *Mandatory* +- `` Alternative names that your sensor driver might have. This may + include manufacturer's name. *Optional* - `` Alternative chip-ids that your sensor driver supports. *Optional* - `` Mention one or more categories the sensor fits in. Can be 'other'. *Mandatory*