[PATCH 8/8] sys: Add files to Doxygen group

[Gedare Bloom]

priority.h and endian.h are imported code. We should modify with care.
I'm not opposed, we just have to think twice.

On Tue, Jul 25, 2023 at 2:49 AM Sebastian Huber
<sebastian.huber at embedded-brains.de> wrote:
>
> Canonicalize brief descriptions.
>
> Update #3707.
> ---
>  cpukit/doxygen/top-level-groups.h | 8 ++++++++
>  cpukit/include/sys/endian.h       | 9 +++++++++
>  cpukit/include/sys/priority.h     | 8 ++++++++
>  cpukit/include/sys/statvfs.h      | 7 ++++---
>  4 files changed, 29 insertions(+), 3 deletions(-)
>
> diff --git a/cpukit/doxygen/top-level-groups.h b/cpukit/doxygen/top-level-groups.h
> index fd32db347a..9d34b3e3dd 100644
> --- a/cpukit/doxygen/top-level-groups.h
> +++ b/cpukit/doxygen/top-level-groups.h
> @@ -40,6 +40,14 @@
>   *   RTEMS.
>   */
>
> +/**
> + * @defgroup RTEMSAPISystemLibrary System Library
> + *
> + * @ingroup RTEMSAPI
> + *
> + * @brief This group contains the system library APIs of RTEMS.
> + */
> +
>  /**
>   * @defgroup RTEMSDeviceDrivers Device Drivers
>   *
> diff --git a/cpukit/include/sys/endian.h b/cpukit/include/sys/endian.h
> index 0849a6a90b..cdd6201736 100644
> --- a/cpukit/include/sys/endian.h
> +++ b/cpukit/include/sys/endian.h
> @@ -1,3 +1,12 @@
> +/**
> + * @file
> + *
> + * @ingroup RTEMSAPISystemLibrary
> + *
> + * @brief This header file provides interfaces of the system endianness
> + *   support.
> + */
> +
>  /*-
>   * Copyright (c) 2002 Thomas Moestl <tmm at FreeBSD.org>
>   * All rights reserved.
> diff --git a/cpukit/include/sys/priority.h b/cpukit/include/sys/priority.h
> index 855edb63c2..37d0d938dc 100644
> --- a/cpukit/include/sys/priority.h
> +++ b/cpukit/include/sys/priority.h
> @@ -1,3 +1,11 @@
> +/**
> + * @file
> + *
> + * @ingroup RTEMSAPISystemLibrary
> + *
> + * @brief This header file provides interfaces of the process priority support.
> + */
> +
>  /*-
>   * SPDX-License-Identifier: BSD-4-Clause
>   *
> diff --git a/cpukit/include/sys/statvfs.h b/cpukit/include/sys/statvfs.h
> index 52d8e9d3fa..655f9a596c 100644
> --- a/cpukit/include/sys/statvfs.h
> +++ b/cpukit/include/sys/statvfs.h
> @@ -3,10 +3,11 @@
>  /**
>   * @file
>   *
> - * @brief Interface to the statvfs() Set of API Methods
> + * @ingroup RTEMSAPISystemLibrary
>   *
> - * This include file defines the interface to the statvfs() set of
> - * API methods. The statvfs as defined by the SUS:
> + * @brief This header file provides the statvfs() and fstatvfs() interfaces.
> + *
> + * The statvfs() is defined by the SUS:
>   *
>   * - http://www.opengroup.org/onlinepubs/009695399/basedefs/sys/statvfs.h.html
>   */
> --
> 2.35.3
>
> _______________________________________________
> devel mailing list
> devel at rtems.org
> http://lists.rtems.org/mailman/listinfo/devel