cpuuse: Use standard wording and group name

Use standard wording in CPU usage reporting files.
This commit is contained in:
Sebastian Huber
2023-01-23 15:33:46 +01:00
parent 6136e28bf9
commit 0340fd9a98
5 changed files with 20 additions and 18 deletions

View File

@@ -3,7 +3,7 @@
/** /**
* @file * @file
* *
* @ingroup libmisc_cpuuse * @ingroup RTEMSAPICPUUsageReporting
* *
* @brief This header file provides the CPU usage reporting API. * @brief This header file provides the CPU usage reporting API.
*/ */
@@ -62,7 +62,7 @@ extern "C" {
/* Generated from spec:/rtems/cpuuse/if/group */ /* Generated from spec:/rtems/cpuuse/if/group */
/** /**
* @defgroup libmisc_cpuuse CPU Usage Reporting * @defgroup RTEMSAPICPUUsageReporting CPU Usage Reporting
* *
* @ingroup RTEMSAPI * @ingroup RTEMSAPI
* *
@@ -78,7 +78,7 @@ struct rtems_printer;
/* Generated from spec:/rtems/cpuuse/if/cpu-info-report */ /* Generated from spec:/rtems/cpuuse/if/cpu-info-report */
/** /**
* @ingroup libmisc_cpuuse * @ingroup RTEMSAPICPUUsageReporting
* *
* @brief Reports the CPU information using the printer plugin. * @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 */ /* Generated from spec:/rtems/cpuuse/if/report */
/** /**
* @ingroup libmisc_cpuuse * @ingroup RTEMSAPICPUUsageReporting
* *
* @brief Reports the CPU usage of each thread using the printk() printer. * @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 */ /* 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. * @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 */ /* Generated from spec:/rtems/cpuuse/if/reset */
/** /**
* @ingroup libmisc_cpuuse * @ingroup RTEMSAPICPUUsageReporting
* *
* @brief Resets the CPU usage of each thread. * @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 */ /* Generated from spec:/rtems/cpuuse/if/top */
/** /**
* @ingroup libmisc_cpuuse * @ingroup RTEMSAPICPUUsageReporting
* *
* @brief Starts an interactive CPU usage reporting using the printk() printer. * @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 */ /* 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. * @brief Starts an interactive CPU usage reporting using the printer plugin.
* *

View File

@@ -3,11 +3,10 @@
/** /**
* @file * @file
* *
* @ingroup libmisc_cpuuse CPU Usage * @ingroup RTEMSAPICPUUsageReporting
* *
* @brief CPU Usage Data * @brief This source file contains the definition of
* * ::CPU_usage_Uptime_at_last_reset.
* CPU Usage Reporter - Shared Data
*/ */
/* /*

View File

@@ -3,9 +3,10 @@
/** /**
* @file * @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().
*/ */
/* /*

View File

@@ -3,9 +3,10 @@
/** /**
* @file * @file
* *
* @ingroup libmisc_cpuuse CPU Usage * @ingroup RTEMSAPICPUUsageReporting
* *
* @brief CPU Usage Reset * @brief This source file contains the definition of
* rtems_cpu_usage_reset().
*/ */
/* /*

View File

@@ -3,9 +3,10 @@
/** /**
* @file * @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().
*/ */
/* /*