From f8c1ce8eeb3e1b33c8956ee0c8b186cf4a6ef88d Mon Sep 17 00:00:00 2001 From: Giovanni Di Sirio Date: Mon, 16 Mar 2020 08:58:02 +0000 Subject: [PATCH] Documentation-related fixes. git-svn-id: svn://svn.code.sf.net/p/chibios/svn/trunk@13429 27425a3e-05d8-49a3-a47f-9c15f0e5edd8 --- doc/ex/Doxyfile_chm | 2 +- doc/ex/Doxyfile_html | 2 +- os/ex/dox/ex_displays.dox | 22 ++++++++++++++++++++++ os/ex/dox/ex_rangefinder.dox | 22 ++++++++++++++++++++++ os/ex/dox/main.dox | 7 +++++++ os/ex/include/ex.h | 2 +- 6 files changed, 54 insertions(+), 3 deletions(-) create mode 100644 os/ex/dox/ex_displays.dox create mode 100644 os/ex/dox/ex_rangefinder.dox diff --git a/doc/ex/Doxyfile_chm b/doc/ex/Doxyfile_chm index 3bbd686a8..6ee0111f3 100644 --- a/doc/ex/Doxyfile_chm +++ b/doc/ex/Doxyfile_chm @@ -38,7 +38,7 @@ PROJECT_NAME = ChibiOS/EX # could be handy for archiving the generated documentation or if some version # control system is used. -PROJECT_NUMBER = 1.1.1 +PROJECT_NUMBER = 1.2.0 # Using the PROJECT_BRIEF tag one can provide an optional one line description # for a project that appears at the top of each page and should give viewer a diff --git a/doc/ex/Doxyfile_html b/doc/ex/Doxyfile_html index a154f2e1c..d2e744785 100644 --- a/doc/ex/Doxyfile_html +++ b/doc/ex/Doxyfile_html @@ -38,7 +38,7 @@ PROJECT_NAME = ChibiOS/EX # could be handy for archiving the generated documentation or if some version # control system is used. -PROJECT_NUMBER = 1.1.1 +PROJECT_NUMBER = 1.2.0 # Using the PROJECT_BRIEF tag one can provide an optional one line description # for a project that appears at the top of each page and should give viewer a diff --git a/os/ex/dox/ex_displays.dox b/os/ex/dox/ex_displays.dox new file mode 100644 index 000000000..fdd77eee8 --- /dev/null +++ b/os/ex/dox/ex_displays.dox @@ -0,0 +1,22 @@ +/* + ChibiOS - Copyright (C) 2006..2018 Giovanni Di Sirio + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +*/ + +/** + * @defgroup EX_RANGEFINDER Generic Range Finder Interface + * @brief EX Generic Range Finder Interface. + * + * @ingroup EX_ABSTRACT_PERIPHERALS + */ diff --git a/os/ex/dox/ex_rangefinder.dox b/os/ex/dox/ex_rangefinder.dox new file mode 100644 index 000000000..06786f377 --- /dev/null +++ b/os/ex/dox/ex_rangefinder.dox @@ -0,0 +1,22 @@ +/* + ChibiOS - Copyright (C) 2006..2018 Giovanni Di Sirio + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +*/ + +/** + * @defgroup EX_DISPLAYS Generic Display Interface + * @brief EX Generic Display Interface. + * + * @ingroup EX_ABSTRACT_PERIPHERALS + */ diff --git a/os/ex/dox/main.dox b/os/ex/dox/main.dox index 1b4deccce..a02193db0 100644 --- a/os/ex/dox/main.dox +++ b/os/ex/dox/main.dox @@ -56,6 +56,13 @@ * of a hardware. */ +/** + * @defgroup EX_INFO Info + * @brief EX information. + * + * @ingroup EX + */ + /** * @defgroup EX_ABSTRACT_PERIPHERALS Peripheral Interfaces * @brief EX Abstract Peripheral Interfaces. diff --git a/os/ex/include/ex.h b/os/ex/include/ex.h index ad63ea338..3748416ee 100644 --- a/os/ex/include/ex.h +++ b/os/ex/include/ex.h @@ -21,7 +21,7 @@ * @file ex.h * @brief EX main include file. * - * @addtogroup ex_info + * @addtogroup EX_INFO * @details EX related info. * @{ */