From 0f015354eff8aa6033c06280a477156bd623da07 Mon Sep 17 00:00:00 2001 From: Mihai Tudor Panu Date: Tue, 23 Jun 2015 10:50:26 -0700 Subject: [PATCH] doxygen: new @altid tag for sensors supporting multiple chip variants Signed-off-by: Mihai Tudor Panu --- docs/documentation.md | 5 +++-- doxy/Doxyfile.in | 1 + 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/docs/documentation.md b/docs/documentation.md index 44435c22..e6377a7a 100644 --- a/docs/documentation.md +++ b/docs/documentation.md @@ -28,6 +28,7 @@ Here's an example (disregard the "@verbatim" tags in your actual code): * @sensor * @comname * @altname + * @altid * @type * @man * @web @@ -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* - `` A short name for your sensor, can include manufacturer name. *Mandatory* -- `` Alternative names or chip-ids that your sensor driver might - have or support respectively. *Optional* +- `` Alternative names that your sensor driver might have. *Optional* +- `` Alternative chip-ids that your sensor driver supports. *Optional* - `` Mention one or more categories the sensor fits in. Can be 'other'. *Mandatory* - `` Sensor manufacturer. Can be 'generic'. *Mandatory* diff --git a/doxy/Doxyfile.in b/doxy/Doxyfile.in index 56ac0f01..32e90b21 100644 --- a/doxy/Doxyfile.in +++ b/doxy/Doxyfile.in @@ -236,6 +236,7 @@ ALIASES = library="@ingroup " \ sensor="@li **ID:** " \ comname="@li **Name:** " \ altname="@li **Other Names:** " \ + altid="@li **Other Chips:** " \ type="@li **Category:** " \ man="@li **Manufacturer:** " \ web="@li **Link:** " \