These doxygen patches look fine.
On Mon, Jan 23, 2023 at 7:35 AM Sebastian Huber
<sebastian.hu...@embedded-brains.de> wrote:
>
> Use standard wording in CPU usage reporting files.
> ---
> cpukit/include/rtems/cpuuse.h | 16 ++++++++--------
> cpukit/libmisc/cpuuse/cpuusagedata.c | 7 +++----
> cpukit/libmisc/cpuuse/cpuusagereport.c | 5 +++--
> cpukit/libmisc/cpuuse/cpuusagereset.c | 5 +++--
> cpukit/libmisc/cpuuse/cpuusagetop.c | 5 +++--
> 5 files changed, 20 insertions(+), 18 deletions(-)
>
> diff --git a/cpukit/include/rtems/cpuuse.h b/cpukit/include/rtems/cpuuse.h
> index 86338a7332..45672d93de 100644
> --- a/cpukit/include/rtems/cpuuse.h
> +++ b/cpukit/include/rtems/cpuuse.h
> @@ -3,7 +3,7 @@
> /**
> * @file
> *
> - * @ingroup libmisc_cpuuse
> + * @ingroup RTEMSAPICPUUsageReporting
> *
> * @brief This header file provides the CPU usage reporting API.
> */
> @@ -62,7 +62,7 @@ extern "C" {
> /* Generated from spec:/rtems/cpuuse/if/group */
>
> /**
> - * @defgroup libmisc_cpuuse CPU Usage Reporting
> + * @defgroup RTEMSAPICPUUsageReporting CPU Usage Reporting
> *
> * @ingroup RTEMSAPI
> *
> @@ -78,7 +78,7 @@ struct rtems_printer;
> /* Generated from spec:/rtems/cpuuse/if/cpu-info-report */
>
> /**
> - * @ingroup libmisc_cpuuse
> + * @ingroup RTEMSAPICPUUsageReporting
> *
> * @brief Reports the CPU information using the printer plugin.
> *
> @@ -100,7 +100,7 @@ int rtems_cpu_info_report( const struct rtems_printer
> *printer );
> /* Generated from spec:/rtems/cpuuse/if/report */
>
> /**
> - * @ingroup libmisc_cpuuse
> + * @ingroup RTEMSAPICPUUsageReporting
> *
> * @brief Reports the CPU usage of each thread using the printk() printer.
> *
> @@ -125,7 +125,7 @@ void rtems_cpu_usage_report( void );
> /* Generated from spec:/rtems/cpuuse/if/report-with-plugin */
>
> /**
> - * @ingroup libmisc_cpuuse
> + * @ingroup RTEMSAPICPUUsageReporting
> *
> * @brief Reports the CPU usage of each thread using the printer plugin.
> *
> @@ -149,7 +149,7 @@ void rtems_cpu_usage_report_with_plugin( const struct
> rtems_printer *printer );
> /* Generated from spec:/rtems/cpuuse/if/reset */
>
> /**
> - * @ingroup libmisc_cpuuse
> + * @ingroup RTEMSAPICPUUsageReporting
> *
> * @brief Resets the CPU usage of each thread.
> *
> @@ -171,7 +171,7 @@ void rtems_cpu_usage_reset( void );
> /* Generated from spec:/rtems/cpuuse/if/top */
>
> /**
> - * @ingroup libmisc_cpuuse
> + * @ingroup RTEMSAPICPUUsageReporting
> *
> * @brief Starts an interactive CPU usage reporting using the printk()
> printer.
> *
> @@ -196,7 +196,7 @@ void rtems_cpu_usage_top( void );
> /* Generated from spec:/rtems/cpuuse/if/top-with-plugin */
>
> /**
> - * @ingroup libmisc_cpuuse
> + * @ingroup RTEMSAPICPUUsageReporting
> *
> * @brief Starts an interactive CPU usage reporting using the printer plugin.
> *
> diff --git a/cpukit/libmisc/cpuuse/cpuusagedata.c
> b/cpukit/libmisc/cpuuse/cpuusagedata.c
> index 350ade309b..b28ba5c3ad 100644
> --- a/cpukit/libmisc/cpuuse/cpuusagedata.c
> +++ b/cpukit/libmisc/cpuuse/cpuusagedata.c
> @@ -3,11 +3,10 @@
> /**
> * @file
> *
> - * @ingroup libmisc_cpuuse CPU Usage
> + * @ingroup RTEMSAPICPUUsageReporting
> *
> - * @brief CPU Usage Data
> - *
> - * CPU Usage Reporter - Shared Data
> + * @brief This source file contains the definition of
> + * ::CPU_usage_Uptime_at_last_reset.
> */
>
> /*
> diff --git a/cpukit/libmisc/cpuuse/cpuusagereport.c
> b/cpukit/libmisc/cpuuse/cpuusagereport.c
> index bc7c897db5..69e9c78518 100644
> --- a/cpukit/libmisc/cpuuse/cpuusagereport.c
> +++ b/cpukit/libmisc/cpuuse/cpuusagereport.c
> @@ -3,9 +3,10 @@
> /**
> * @file
> *
> - * @ingroup libmisc_cpuuse CPU Usage
> + * @ingroup RTEMSAPICPUUsageReporting
> *
> - * @brief CPU Usage Report
> + * @brief This source file contains the definition of
> + * rtems_cpu_usage_report() and rtems_cpu_usage_report_with_plugin().
> */
>
> /*
> diff --git a/cpukit/libmisc/cpuuse/cpuusagereset.c
> b/cpukit/libmisc/cpuuse/cpuusagereset.c
> index bdfba7c944..e8b76cd189 100644
> --- a/cpukit/libmisc/cpuuse/cpuusagereset.c
> +++ b/cpukit/libmisc/cpuuse/cpuusagereset.c
> @@ -3,9 +3,10 @@
> /**
> * @file
> *
> - * @ingroup libmisc_cpuuse CPU Usage
> + * @ingroup RTEMSAPICPUUsageReporting
> *
> - * @brief CPU Usage Reset
> + * @brief This source file contains the definition of
> + * rtems_cpu_usage_reset().
> */
>
> /*
> diff --git a/cpukit/libmisc/cpuuse/cpuusagetop.c
> b/cpukit/libmisc/cpuuse/cpuusagetop.c
> index 045a38ae55..1ee3a5571c 100644
> --- a/cpukit/libmisc/cpuuse/cpuusagetop.c
> +++ b/cpukit/libmisc/cpuuse/cpuusagetop.c
> @@ -3,9 +3,10 @@
> /**
> * @file
> *
> - * @ingroup libmisc_cpuuse CPU Usage
> + * @ingroup RTEMSAPICPUUsageReporting
> *
> - * @brief CPU Usage Top
> + * @brief This source file contains the definition of
> + * rtems_cpu_usage_top() and rtems_cpu_usage_top_with_plugin().
> */
>
> /*
> --
> 2.35.3
>
> _______________________________________________
> devel mailing list
> devel@rtems.org
> http://lists.rtems.org/mailman/listinfo/devel
_______________________________________________
devel mailing list
devel@rtems.org
http://lists.rtems.org/mailman/listinfo/devel
