[PATCH 1/5] cpukit: Remove old DESCRIPTION: in comments
Joel Sherrill
joel.sherrill at oarcorp.com
Wed Mar 11 16:08:57 UTC 2015
These were remnants of pre-Doxygen comment style.
---
cpukit/libmisc/capture/capture-cli.c | 60 --------------------------
cpukit/libmisc/capture/capture-cli.h | 3 --
cpukit/libmisc/capture/capture_support.c | 7 +--
cpukit/libmisc/fb/fb.h | 3 --
cpukit/libmisc/fb/mw_uid.c | 9 ++--
cpukit/rtems/include/rtems/rtems/sem.h | 8 ++--
cpukit/rtems/src/barrier.c | 28 ++++--------
cpukit/rtems/src/semrelease.c | 16 +------
cpukit/score/cpu/m68k/rtems/score/m68k.h | 10 ++---
cpukit/score/include/rtems/score/coremsgimpl.h | 6 ---
cpukit/score/include/rtems/score/coresemimpl.h | 3 --
cpukit/score/src/coremutexsurrender.c | 2 -
12 files changed, 24 insertions(+), 131 deletions(-)
diff --git a/cpukit/libmisc/capture/capture-cli.c b/cpukit/libmisc/capture/capture-cli.c
index d790b85..b2200bc 100644
--- a/cpukit/libmisc/capture/capture-cli.c
+++ b/cpukit/libmisc/capture/capture-cli.c
@@ -55,11 +55,8 @@ static rtems_capture_timestamp capture_timestamp;
/*
* rtems_capture_cli_open
*
- * DESCRIPTION:
- *
* This function opens the capture engine. We need the size of the
* capture buffer.
- *
*/
static const char* open_usage = "usage: copen [-i] size\n";
@@ -129,10 +126,7 @@ rtems_capture_cli_open (int argc,
/*
* rtems_capture_cli_close
*
- * DESCRIPTION:
- *
* This function closes the capture engine.
- *
*/
static void
@@ -157,10 +151,7 @@ rtems_capture_cli_close (int argc RC_UNUSED,
/*
* rtems_capture_cli_enable
*
- * DESCRIPTION:
- *
* This function enables the capture engine.
- *
*/
static void
@@ -185,10 +176,7 @@ rtems_capture_cli_enable (int argc RC_UNUSED,
/*
* rtems_capture_cli_disable
*
- * DESCRIPTION:
- *
* This function disables the capture engine.
- *
*/
static void
@@ -253,11 +241,8 @@ rtems_capture_cli_print_task (rtems_tcb *tcb)
/*
* rtems_capture_cli_count_tasks
*
- * DESCRIPTION:
- *
* This function is called for each tcb and counts the
* number of tasks.
- *
*/
static void
@@ -270,10 +255,7 @@ rtems_capture_cli_count_tasks (rtems_tcb *tcb)
/*
* rtems_capture_cli_task_list
*
- * DESCRIPTION:
- *
* This function lists the tasks the capture engine knows about.
- *
*/
static void
@@ -298,10 +280,7 @@ rtems_capture_cli_task_list (int argc RC_UNUSED,
/*
* rtems_capture_cli_watch_list
*
- * DESCRIPTION:
- *
* This function lists the controls in the capture engine.
- *
*/
static void
@@ -316,10 +295,7 @@ rtems_capture_cli_watch_list (int argc RC_UNUSED,
/*
* rtems_capture_cli_get_name_id
*
- * DESCRIPTION:
- *
* This function checks arguments for a name or an id.
- *
*/
static bool
@@ -375,11 +351,8 @@ rtems_capture_cli_get_name_id (char* arg,
/*
* rtems_capture_cli_watch_add
*
- * DESCRIPTION:
- *
* This function is a monitor command that add a watch to the capture
* engine.
- *
*/
static char const * watch_add_usage = "usage: cwadd [task name] [id]\n";
@@ -438,11 +411,8 @@ rtems_capture_cli_watch_add (int argc,
/*
* rtems_capture_cli_watch_del
*
- * DESCRIPTION:
- *
* This function is a monitor command that deletes a watch from the capture
* engine.
- *
*/
static char const * watch_del_usage = "usage: cwdel [task name] [id]\n";
@@ -501,10 +471,7 @@ rtems_capture_cli_watch_del (int argc,
/*
* rtems_capture_cli_watch_control
*
- * DESCRIPTION:
- *
* This function is a monitor command that controls a watch.
- *
*/
static char const * watch_control_usage = "usage: cwctl [task name] [id] on/off\n";
@@ -568,10 +535,7 @@ rtems_capture_cli_watch_control (int argc,
/*
* rtems_capture_cli_watch_global
*
- * DESCRIPTION:
- *
* This function is a monitor command that sets a global watch.
- *
*/
static char const * watch_global_usage = "usage: cwglob on/off\n";
@@ -622,10 +586,7 @@ rtems_capture_cli_watch_global (int argc,
/*
* rtems_capture_cli_watch_ceiling
*
- * DESCRIPTION:
- *
* This function is a monitor command that sets watch ceiling.
- *
*/
static char const * watch_ceiling_usage = "usage: cwceil priority\n";
@@ -673,10 +634,7 @@ rtems_capture_cli_watch_ceiling (int argc,
/*
* rtems_capture_cli_watch_floor
*
- * DESCRIPTION:
- *
* This function is a monitor command that sets watch floor.
- *
*/
static char const * watch_floor_usage = "usage: cwfloor priority\n";
@@ -724,10 +682,7 @@ rtems_capture_cli_watch_floor (int argc,
/*
* rtems_capture_cli_trigger_worker
*
- * DESCRIPTION:
- *
* This function is a monitor command that sets or clears a trigger.
- *
*/
static char const *trigger_set_usage =
@@ -969,10 +924,7 @@ rtems_capture_cli_trigger_worker (int set, int argc, char** argv)
/*
* rtems_capture_cli_trigger_set
*
- * DESCRIPTION:
- *
* This function is a monitor command that sets a trigger.
- *
*/
static void
@@ -987,10 +939,7 @@ rtems_capture_cli_trigger_set (int argc,
/*
* rtems_capture_cli_trigger_clear
*
- * DESCRIPTION:
- *
* This function is a monitor command that clears a trigger.
- *
*/
static void
@@ -1005,10 +954,7 @@ rtems_capture_cli_trigger_clear (int argc,
/*
* rtems_capture_cli_trace_records
*
- * DESCRIPTION:
- *
* This function is a monitor command that dumps trace records.
- *
*/
static void
@@ -1054,11 +1000,8 @@ rtems_capture_cli_trace_records (int argc,
/*
* rtems_capture_cli_flush
*
- * DESCRIPTION:
- *
* This function is a monitor command that flushes and primes the capture
* engine.
- *
*/
static void
@@ -1229,11 +1172,8 @@ static rtems_monitor_command_entry_t rtems_capture_cli_cmds[] =
/*
* rtems_capture_cli_init
*
- * DESCRIPTION:
- *
* This function initialises the command line interface to the capture
* engine.
- *
*/
rtems_status_code
diff --git a/cpukit/libmisc/capture/capture-cli.h b/cpukit/libmisc/capture/capture-cli.h
index 7f07766..24d1e88 100644
--- a/cpukit/libmisc/capture/capture-cli.h
+++ b/cpukit/libmisc/capture/capture-cli.h
@@ -41,11 +41,8 @@ extern "C" {
/**
* rtems_capture_cli_init
*
- * DESCRIPTION:
- *
* This function initialises the command line interface to the capture
* engine.
- *
*/
rtems_status_code
rtems_capture_cli_init (rtems_capture_timestamp timestamp);
diff --git a/cpukit/libmisc/capture/capture_support.c b/cpukit/libmisc/capture/capture_support.c
index a33aa2d..05e0e3b 100644
--- a/cpukit/libmisc/capture/capture_support.c
+++ b/cpukit/libmisc/capture/capture_support.c
@@ -50,8 +50,6 @@ typedef struct {
/*
* rtems_catpure_print_uptime
*
- * DESCRIPTION:
- *
* This function prints the nanosecond uptime to stdout.
*/
void
@@ -122,12 +120,9 @@ rtems_capture_print_record_capture(
}
/*
- * rtems_capture_print_trace_records
- *
- * DESCRIPTION:
+ * rtems_capture_print_trace_records
*
* This function is a monitor command that dumps trace records.
- *
*/
void
diff --git a/cpukit/libmisc/fb/fb.h b/cpukit/libmisc/fb/fb.h
index e268418..bb5cb23 100644
--- a/cpukit/libmisc/fb/fb.h
+++ b/cpukit/libmisc/fb/fb.h
@@ -8,9 +8,6 @@
/*
* Copyright (c) 2000 - Rosimildo da Silva
- *
- * MODULE DESCRIPTION:
- * Micro FrameBuffer interface for Embedded Systems.
*/
#ifndef _MW_FB_H
diff --git a/cpukit/libmisc/fb/mw_uid.c b/cpukit/libmisc/fb/mw_uid.c
index a911e09..2381089 100644
--- a/cpukit/libmisc/fb/mw_uid.c
+++ b/cpukit/libmisc/fb/mw_uid.c
@@ -3,17 +3,16 @@
*
* @brief MicroWindows UID
* @ingroup libmisc_fb_mw Input Devices for MicroWindows
- */
-
-/*
- * Copyright (c) 2000 - Rosimildo da Silva
*
- * MODULE DESCRIPTION:
* This module implements the input devices interface used by MicroWindows
* in an embedded system environment. It uses the RTEMS message queue as
* the repository for the messages posted by the devices registered.
*/
+/*
+ * Copyright (c) 2000 - Rosimildo da Silva
+ */
+
#ifdef HAVE_CONFIG_H
#include "config.h"
#endif
diff --git a/cpukit/rtems/include/rtems/rtems/sem.h b/cpukit/rtems/include/rtems/rtems/sem.h
index 2442010..6df9b55 100644
--- a/cpukit/rtems/include/rtems/rtems/sem.h
+++ b/cpukit/rtems/include/rtems/rtems/sem.h
@@ -17,9 +17,12 @@
* - delete a semaphore
* - acquire a semaphore
* - release a semaphore
+ * - flush a semaphore
+ * - set ceiling priority for a semaphore
*/
-/* COPYRIGHT (c) 1989-2008.
+/*
+ * COPYRIGHT (c) 1989-2008.
* On-Line Applications Research Corporation (OAR).
*
* The license and distribution terms for this file may be
@@ -198,8 +201,7 @@ rtems_status_code rtems_semaphore_release(
/**
* @brief RTEMS Semaphore Flush
*
- * DESCRIPTION:
- * This package is the implementation of the flush directive
+ * This method is the implementation of the flush directive
* of the Semaphore Manager.
*
* This directive allows a thread to flush the threads
diff --git a/cpukit/rtems/src/barrier.c b/cpukit/rtems/src/barrier.c
index 86854b9..e693329 100644
--- a/cpukit/rtems/src/barrier.c
+++ b/cpukit/rtems/src/barrier.c
@@ -1,19 +1,12 @@
-/*
- * Barrier Manager
- *
- * DESCRIPTION:
- *
- * This package is the implementation of the Barrier Manager.
- *
- * Directives provided are:
- *
- * + create a barrier
- * + get an ID of a barrier
- * + delete a barrier
- * + acquire a barrier
- * + release a barrier
+/**
+ * @file
*
- * COPYRIGHT (c) 1989-2008.
+ * @brief RTEMS Barrier Manager Initialization
+ * @ingroup ClassicBarrier Barriers
+ */
+
+/*
+ * COPYRIGHT (c) 1989-2015.
* On-Line Applications Research Corporation (OAR).
*
* The license and distribution terms for this file may be
@@ -33,12 +26,7 @@
/**
* @brief _Barrier_Manager_initialization
- *
- * Input parameters: NONE
- *
- * Output parameters: NONE
*/
-
void _Barrier_Manager_initialization(void)
{
_Objects_Initialize_information(
diff --git a/cpukit/rtems/src/semrelease.c b/cpukit/rtems/src/semrelease.c
index 2c4be04..37a05b2 100644
--- a/cpukit/rtems/src/semrelease.c
+++ b/cpukit/rtems/src/semrelease.c
@@ -4,20 +4,8 @@
* @brief RTEMS Semaphore Release
* @ingroup ClassicSem Semaphores
*
- * DESCRIPTION:
- *
- * This package is the implementation of the Semaphore Manager.
- * This manager utilizes standard Dijkstra counting semaphores to provide
- * synchronization and mutual exclusion capabilities.
- *
- * Directives provided are:
- *
- * + create a semaphore
- * + get an ID of a semaphore
- * + delete a semaphore
- * + acquire a semaphore
- * + release a semaphore
- *
+ * This file contains the implementation of the Classic API directive
+ * rtems_semaphore_release().
*/
/*
diff --git a/cpukit/score/cpu/m68k/rtems/score/m68k.h b/cpukit/score/cpu/m68k/rtems/score/m68k.h
index 3a5a009..818578c 100644
--- a/cpukit/score/cpu/m68k/rtems/score/m68k.h
+++ b/cpukit/score/cpu/m68k/rtems/score/m68k.h
@@ -480,13 +480,11 @@ static inline uint16_t m68k_swap_u16(
/*
* _CPU_virtual_to_physical
*
- * DESCRIPTION:
+ * This function is used to map virtual addresses to physical
+ * addresses.
*
- * This function is used to map virtual addresses to physical
- * addresses.
- *
- * FIXME: ASSUMES THAT VIRTUAL ADDRESSES ARE THE SAME AS THE
- * PHYSICAL ADDRESSES
+ * FIXME: ASSUMES THAT VIRTUAL ADDRESSES ARE THE SAME AS THE
+ * PHYSICAL ADDRESSES
*/
static inline void * _CPU_virtual_to_physical (
const void * d_addr )
diff --git a/cpukit/score/include/rtems/score/coremsgimpl.h b/cpukit/score/include/rtems/score/coremsgimpl.h
index 6c1f901..52796ad 100644
--- a/cpukit/score/include/rtems/score/coremsgimpl.h
+++ b/cpukit/score/include/rtems/score/coremsgimpl.h
@@ -113,8 +113,6 @@ typedef void ( *CORE_message_queue_API_mp_support_callout )(
/**
* @brief Initialize a message queue.
*
- * DESCRIPTION:
- *
* This package is the implementation of the CORE Message Queue Handler.
* This core object provides task synchronization and communication functions
* via messages passed to queue objects.
@@ -144,7 +142,6 @@ bool _CORE_message_queue_Initialize(
/**
* @brief Close a message queue.
*
- * DESCRIPTION:
* This package is the implementation of the CORE Message Queue Handler.
* This core object provides task synchronization and communication functions
* via messages passed to queue objects
@@ -167,7 +164,6 @@ void _CORE_message_queue_Close(
/**
* @brief Flush pending messages.
*
- * DESCRIPTION:
* This package is the implementation of the CORE Message Queue Handler.
* This core object provides task synchronization and communication functions
* via messages passed to queue objects.
@@ -220,7 +216,6 @@ uint32_t _CORE_message_queue_Flush_support(
/**
* @brief Broadcast a message to the message queue.
*
- * DESCRIPTION:
* This package is the implementation of the CORE Message Queue Handler.
* This core object provides task synchronization and communication functions
* via messages passed to queue objects.
@@ -289,7 +284,6 @@ CORE_message_queue_Status _CORE_message_queue_Submit(
/**
* @brief Size a message from the message queue.
*
- * DESCRIPTION:
* This package is the implementation of the CORE Message Queue Handler.
* This core object provides task synchronization and communication functions
* via messages passed to queue objects.
diff --git a/cpukit/score/include/rtems/score/coresemimpl.h b/cpukit/score/include/rtems/score/coresemimpl.h
index a29ee28..fda908e 100644
--- a/cpukit/score/include/rtems/score/coresemimpl.h
+++ b/cpukit/score/include/rtems/score/coresemimpl.h
@@ -81,8 +81,6 @@ typedef void ( *CORE_semaphore_API_mp_support_callout )(
/**
* @brief Initialize the semaphore based on the parameters passed.
*
- * DESCRIPTION:
- *
* This package is the implementation of the CORE Semaphore Handler.
* This core object utilizes standard Dijkstra counting semaphores to provide
* synchronization and mutual exclusion capabilities.
@@ -147,7 +145,6 @@ CORE_semaphore_Status _CORE_semaphore_Surrender(
/**
* @brief Core semaphore flush.
*
- * DESCRIPTION:
* This package is the implementation of the CORE Semaphore Handler.
* This core object utilizes standard Dijkstra counting semaphores to provide
* synchronization and mutual exclusion capabilities.
diff --git a/cpukit/score/src/coremutexsurrender.c b/cpukit/score/src/coremutexsurrender.c
index 7a7a047..8fba301 100644
--- a/cpukit/score/src/coremutexsurrender.c
+++ b/cpukit/score/src/coremutexsurrender.c
@@ -71,8 +71,6 @@
/*
* _CORE_mutex_Surrender
*
- * DESCRIPTION:
- *
* This routine frees a unit to the mutex. If a task was blocked waiting for
* a unit from this mutex, then that task will be readied and the unit
* given to that task. Otherwise, the unit will be returned to the mutex.
--
1.9.3
More information about the devel
mailing list