From 9e7ae25e49648f92a7ef092b9ec39cec8db121ac Mon Sep 17 00:00:00 2001
From: Giovanni Di Sirio <gdisirio@gmail.com>
Date: Thu, 3 May 2018 11:54:03 +0000
Subject: Documentation-related improvements.

git-svn-id: svn://svn.code.sf.net/p/chibios/svn/trunk@11989 110e8d01-0319-4d1e-a829-52ad28d1bb01
---
 os/license/chcustomer.h        |  5 ++++-
 os/license/chlicense.h         |  4 +++-
 os/license/chversion.h         |  4 +++-
 os/license/license.dox         | 37 +++++++++++++++++++++++++++++++++++++
 os/rt/dox/rt.dox               |  5 +++--
 os/rt/include/chrestrictions.h |  7 +++++++
 6 files changed, 57 insertions(+), 5 deletions(-)
 create mode 100644 os/license/license.dox

(limited to 'os')

diff --git a/os/license/chcustomer.h b/os/license/chcustomer.h
index 433d26db2..61aed864e 100644
--- a/os/license/chcustomer.h
+++ b/os/license/chcustomer.h
@@ -21,7 +21,10 @@
  * @file    chcustomer.h
  * @brief   Customer-related info.
  *
- * @addtogroup customer
+ * @addtogroup chibios_customer
+ * @details This module incapsulates licensee information, this is only
+ *          meaningful for commercial licenses. It is a stub for public
+ *          releases.
  * @{
  */
 
diff --git a/os/license/chlicense.h b/os/license/chlicense.h
index 7d1c345ac..9a956de3d 100644
--- a/os/license/chlicense.h
+++ b/os/license/chlicense.h
@@ -21,7 +21,9 @@
  * @file    chlicense.h
  * @brief   License Module macros and structures.
  *
- * @addtogroup license
+ * @addtogroup chibios_license
+ * @details This module contains all the definitions required for defining
+ *          a licensing scheme for customers or public releases.
  * @{
  */
 
diff --git a/os/license/chversion.h b/os/license/chversion.h
index 5766f3162..91c7d59b1 100644
--- a/os/license/chversion.h
+++ b/os/license/chversion.h
@@ -21,7 +21,9 @@
  * @file    chversion.h
  * @brief   Version Module macros and structures.
  *
- * @addtogroup version
+ * @addtogroup chibios_version
+ * @details This module contains information about the ChibiOS release, it
+ *          is common to all subsystems.
  * @{
  */
 
diff --git a/os/license/license.dox b/os/license/license.dox
new file mode 100644
index 000000000..b240e1544
--- /dev/null
+++ b/os/license/license.dox
@@ -0,0 +1,37 @@
+/*
+    ChibiOS - Copyright (C) 2006..2018 Giovanni Di Sirio.
+
+    This file is part of ChibiOS.
+
+    ChibiOS is free software; you can redistribute it and/or modify
+    it under the terms of the GNU General Public License as published by
+    the Free Software Foundation; either version 3 of the License, or
+    (at your option) any later version.
+
+    ChibiOS is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU General Public License for more details.
+
+    You should have received a copy of the GNU General Public License
+    along with this program.  If not, see <http://www.gnu.org/licenses/>.
+*/
+
+/**
+ * @defgroup licensing Release and Licensing
+ */
+
+/**
+ * @defgroup chibios_version Release Information
+ * @ingroup licensing
+ */
+
+/**
+ * @defgroup chibios_customer Customer Information
+ * @ingroup licensing
+ */
+
+/**
+ * @defgroup chibios_license License Settings
+ * @ingroup licensing
+ */
diff --git a/os/rt/dox/rt.dox b/os/rt/dox/rt.dox
index bd19984ba..5664e57a2 100644
--- a/os/rt/dox/rt.dox
+++ b/os/rt/dox/rt.dox
@@ -22,6 +22,7 @@
  * @details The kernel is the portable part of ChibiOS/RT, this section
  *          documents the various kernel subsystems.
  */
+ */
 
 /**
  * @defgroup kernel_info Version Numbers and Identification
@@ -44,8 +45,8 @@
  */
 
 /**
- * @defgroup checks License Checks
- * @ingroup kernel
+ * @defgroup rt_restrictions Restrictions
+ * @ingroup config_category
  */
 
 /**
diff --git a/os/rt/include/chrestrictions.h b/os/rt/include/chrestrictions.h
index 3871b3c59..5981aa319 100644
--- a/os/rt/include/chrestrictions.h
+++ b/os/rt/include/chrestrictions.h
@@ -20,6 +20,11 @@
 /**
  * @file    chrestrictions.h
  * @brief   Licensing restrictions header.
+ *
+ * @addtogroup rt_restrictions
+ * @details This module is responsible for applying license-related
+ *          restrictions to the configuration options.
+ * @{
  */
 
 #ifndef CHRESTRICTIONS_H
@@ -109,3 +114,5 @@
 /*===========================================================================*/
 
 #endif /* CHRESTRICTIONS_H */
+
+/** @} */
-- 
cgit v1.2.3