[rtems commit] libcsupport: Doxygen Clean Up Task #1
Jennifer Averett
jennifer at rtems.org
Tue Jan 8 12:36:24 UTC 2013
Module: rtems
Branch: master
Commit: 4027e6332cf6cff450b286905711aa0f25c4a0df
Changeset: http://git.rtems.org/rtems/commit/?id=4027e6332cf6cff450b286905711aa0f25c4a0df
Author: Alex Ivanov <alexivanov97 at gmail.com>
Date: Tue Jan 8 06:40:27 2013 -0600
libcsupport: Doxygen Clean Up Task #1
---
cpukit/libcsupport/include/clockdrv.h | 2 +-
cpukit/libcsupport/include/console.h | 106 +++++++++++------------
cpukit/libcsupport/include/ringbuf.h | 6 +-
cpukit/libcsupport/include/rtc.h | 2 +
cpukit/libcsupport/include/rtems/deviceio.h | 21 +++--
cpukit/libcsupport/include/rtems/libcsupport.h | 39 +++++----
cpukit/libcsupport/include/rtems/libio_.h | 74 +++++++++--------
cpukit/libcsupport/include/sys/statvfs.h | 6 +-
cpukit/libcsupport/include/sys/termios.h | 16 ++--
cpukit/libcsupport/include/sys/utsname.h | 15 ++-
cpukit/libcsupport/include/timerdrv.h | 2 +-
cpukit/libcsupport/include/vmeintr.h | 6 +-
cpukit/libcsupport/include/zilog/z8036.h | 2 +-
cpukit/libcsupport/include/zilog/z8530.h | 6 +-
cpukit/libcsupport/include/zilog/z8536.h | 2 +-
15 files changed, 162 insertions(+), 143 deletions(-)
diff --git a/cpukit/libcsupport/include/clockdrv.h b/cpukit/libcsupport/include/clockdrv.h
index 6acf83e..999af92 100644
--- a/cpukit/libcsupport/include/clockdrv.h
+++ b/cpukit/libcsupport/include/clockdrv.h
@@ -1,5 +1,5 @@
/**
- * @file rtems/clockdrv.h
+ * @file
*
* @brief Clock Driver for all Boards
*
diff --git a/cpukit/libcsupport/include/console.h b/cpukit/libcsupport/include/console.h
index 137959a..9cd0e96 100644
--- a/cpukit/libcsupport/include/console.h
+++ b/cpukit/libcsupport/include/console.h
@@ -1,5 +1,7 @@
/**
- * @file rtems/console.h
+ * @file
+ *
+ * @brief Console Driver for all Boards
*
* This file describes the Console Device Driver for all boards.
* This driver provides support for the standard C Library.
@@ -24,30 +26,29 @@ extern "C" {
#endif
/**
- * This macro defines the standard name for the console device
- * that is available to applications.
+ * This macro defines the standard name for the console device
+ * that is available to applications.
*/
#define CONSOLE_DEVICE_NAME "/dev/console"
/**
- * This macro defines the standard device driver table entry for
- * a console device driver.
+ * This macro defines the standard device driver table entry for
+ * a console device driver.
*/
#define CONSOLE_DRIVER_TABLE_ENTRY \
{ console_initialize, console_open, console_close, \
console_read, console_write, console_control }
/**
- * @brief Console Initialization Entry Point
+ * @brief Console initialization entry point.
*
- * This method initializes the console device driver.
+ * This method initializes the console device driver.
*
- * @param[in] major is the device driver major number
- * @param[in] minor is the device driver minor number
- * @param[in] arg is the parameters to this call
- *
- * @return This method returns RTEMS_SUCCESSFUL when
- * the device driver is successfully initialized.
+ * @param[in] major is the device driver major number.
+ * @param[in] minor is the device driver minor number.
+ * @param[in] arg is the parameters to this call.
+ *.
+ * @retval RTEMS_SUCCESSFUL The device driver is successfully initialized.
*/
rtems_device_driver console_initialize(
rtems_device_major_number major,
@@ -56,17 +57,16 @@ rtems_device_driver console_initialize(
);
/**
- * @brief Console Open Entry Point
+ * @brief Console open entry point.
*
- * This method opens a specific device supported by the
- * console device driver.
+ * This method opens a specific device supported by the
+ * console device driver.
*
- * @param[in] major is the device driver major number
- * @param[in] minor is the device driver minor number
- * @param[in] arg is the parameters to this call
+ * @param[in] major is the device driver major number
+ * @param[in] minor is the device driver minor number
+ * @param[in] arg is the parameters to this call
*
- * @return This method returns RTEMS_SUCCESSFUL when
- * the device driver is successfully opened.
+ * @retval RTEMS_SUCCESSFUL The device driver is successfully opened.
*/
rtems_device_driver console_open(
rtems_device_major_number major,
@@ -75,17 +75,16 @@ rtems_device_driver console_open(
);
/**
- * @brief Console Close Entry Point
+ * @brief Console close entry point.
*
- * This method closes a specific device supported by the
- * console device driver.
+ * This method closes a specific device supported by the
+ * console device driver.
*
- * @param[in] major is the device driver major number
- * @param[in] minor is the device driver minor number
- * @param[in] arg is the parameters to this call
+ * @param[in] major is the device driver major number
+ * @param[in] minor is the device driver minor number
+ * @param[in] arg is the parameters to this call
*
- * @return This method returns RTEMS_SUCCESSFUL when
- * the device is successfully closed.
+ * @retval RTEMS_SUCCESSFUL The device driver is successfully closed.
*/
rtems_device_driver console_close(
rtems_device_major_number major,
@@ -94,17 +93,16 @@ rtems_device_driver console_close(
);
/**
- * @brief Console Read Entry Point
+ * @brief Console read entry point.
*
- * This method reads from a specific device supported by the
- * console device driver.
+ * This method reads from a specific device supported by the
+ * console device driver.
*
- * @param[in] major is the device driver major number
- * @param[in] minor is the device driver minor number
- * @param[in] arg is the parameters to this call
+ * @param[in] major is the device driver major number
+ * @param[in] minor is the device driver minor number
+ * @param[in] arg is the parameters to this call
*
- * @return This method returns RTEMS_SUCCESSFUL when
- * the device is successfully read from.
+ * @retval RTEMS_SUCCESSFUL The device is successfully read from.
*/
rtems_device_driver console_read(
rtems_device_major_number major,
@@ -113,17 +111,16 @@ rtems_device_driver console_read(
);
/**
- * @brief Console Write Entry Point
+ * @brief Console write entry point.
*
- * This method writes to a specific device supported by the
- * console device driver.
+ * This method writes to a specific device supported by the
+ * console device driver.
*
- * @param[in] major is the device driver major number
- * @param[in] minor is the device driver minor number
- * @param[in] arg is the parameters to this call
+ * @param[in] major is the device driver major number
+ * @param[in] minor is the device driver minor number
+ * @param[in] arg is the parameters to this call
*
- * @return This method returns RTEMS_SUCCESSFUL when
- * the device is successfully written.
+ * @retval RTEMS_SUCCESSFUL The device is successfully written.
*/
rtems_device_driver console_write(
rtems_device_major_number major,
@@ -132,18 +129,17 @@ rtems_device_driver console_write(
);
/**
- * @brief Console IO Control Entry Point
- *
- * This method performs an IO Control operation on a
- * specific device supported by the console device driver.
+ * @brief Console IO control entry point.
*
- * @param[in] major is the device driver major number
- * @param[in] minor is the device driver minor number
- * @param[in] arg is the parameters to this call
+ * This method performs an IO Control operation on a
+ * specific device supported by the console device driver.
*
- * @return This method returns RTEMS_SUCCESSFUL when
- * the device driver IO control operation is
- * successfully performed.
+ * @param[in] major is the device driver major number
+ * @param[in] minor is the device driver minor number
+ * @param[in] arg is the parameters to this call
+ *
+ * @retval RTEMS_SUCCESSFUL the device driver IO control operation is
+ * successfully performed.
*/
rtems_device_driver console_control(
rtems_device_major_number major,
diff --git a/cpukit/libcsupport/include/ringbuf.h b/cpukit/libcsupport/include/ringbuf.h
index 0e86f39..99e72a5 100644
--- a/cpukit/libcsupport/include/ringbuf.h
+++ b/cpukit/libcsupport/include/ringbuf.h
@@ -1,9 +1,9 @@
/**
- * @file rtems/ringbuf.h
+ * @file
*
- * @brief Simple Ring Buffer Functionality
+ * @brief Simple Ring Buffer Functionality
*
- * This file provides simple ring buffer functionality.
+ * This file provides simple ring buffer functionality.
*/
diff --git a/cpukit/libcsupport/include/rtc.h b/cpukit/libcsupport/include/rtc.h
index 4b8e601..29ef4cd 100644
--- a/cpukit/libcsupport/include/rtc.h
+++ b/cpukit/libcsupport/include/rtc.h
@@ -1,6 +1,8 @@
/**
* @file
*
+ * @brief Real-Time Clock Driver Interface
+ *
* Real-time clock driver interface.
*/
diff --git a/cpukit/libcsupport/include/rtems/deviceio.h b/cpukit/libcsupport/include/rtems/deviceio.h
index b832942..df78852 100644
--- a/cpukit/libcsupport/include/rtems/deviceio.h
+++ b/cpukit/libcsupport/include/rtems/deviceio.h
@@ -1,7 +1,8 @@
/**
- * @file rtems/deviceio.h
+ * @file
*
- * @brief Map Operations on IMFS Device Nodes to the RTEMS Classic API IO Manager
+ * @brief Map Operations on IMFS Device Nodes to the RTEMS Classic API
+ * IO Manager
*/
/*
@@ -18,8 +19,10 @@
/**
* @defgroup Device IO Handler
+ *
+ *
+ * @{
*/
-/**@{*/
#include <rtems/libio.h>
@@ -28,12 +31,12 @@ extern "C" {
#endif /* __cplusplus */
/**
- * @brief IMFS Device Node Handlers
+ * @brief IMFS device node handlers.
*
- * IMFS Device Node Handlers
+ * IMFS Device Node Handlers
*
- * This file contains the set of handlers used to map operations on
- * IMFS device nodes onto calls to the RTEMS Classic API IO Manager.
+ * This file contains the set of handlers used to map operations on
+ * IMFS device nodes onto calls to the RTEMS Classic API IO Manager.
*/
int rtems_deviceio_errno( rtems_status_code status );
@@ -76,10 +79,12 @@ int rtems_deviceio_control(
rtems_device_minor_number minor
);
+/** @} */
+
#ifdef __cplusplus
}
#endif
-/**@}*/
+
/* __cplusplus */
#endif /* _RTEMS_DEVICEIO_H */
diff --git a/cpukit/libcsupport/include/rtems/libcsupport.h b/cpukit/libcsupport/include/rtems/libcsupport.h
index 32ed8a8..808c0fb 100644
--- a/cpukit/libcsupport/include/rtems/libcsupport.h
+++ b/cpukit/libcsupport/include/rtems/libcsupport.h
@@ -30,29 +30,31 @@ extern "C" {
#endif
/**
- * @defgroup libcsupport Standard C Library Support
+ * @defgroup libcsupport Standard C Library Support
*
- * @brief RTEMS Specific Support for the Standard C Library
+ * @brief RTEMS Specific Support for the Standard C Library
+ *
+ * @{
*/
extern void malloc_dump(void);
/**
- * @brief Malloc Walk
+ * @brief Malloc walk.
*/
extern bool malloc_walk(int source, bool printf_enabled);
/**
- * @brief RTEMS Malloc Set Heap Pointer
+ * @brief Set malloc heap pointer.
*
- * This routine is primarily used for debugging.
+ * This routine is primarily used for debugging.
*/
void malloc_set_heap_pointer(Heap_Control *new_heap);
/**
- * @brief RTEMS Malloc Get Heap Pointer
+ * @brief Get malloc heap pointer.
*
- * This routine is primarily used for debugging.
+ * This routine is primarily used for debugging.
*/
Heap_Control *malloc_get_heap_pointer( void );
extern void libc_init(void);
@@ -60,17 +62,17 @@ extern int host_errno(void);
extern void fix_syscall_errno(void);
/**
- * @brief RTEMS Malloc Get Free Information
+ * @brief Get free malloc information.
*
- * Find amount of free heap remaining
+ * Find amount of free heap remaining
*/
extern size_t malloc_free_space(void);
extern void open_dev_console(void);
/**
- * @brief RTEMS Malloc Get Status Information
+ * @brief Get malloc status information.
*
- * Find amount of free heap remaining.
+ * Find amount of free heap remaining.
*/
extern int malloc_info(Heap_Information_block *the_info);
@@ -139,7 +141,7 @@ typedef struct {
/**
* @brief Tasks a snapshot of the resource usage of the system.
*
- * @param[out] snapshot The snapshot of used resources.
+ * @param[out] snapshot will contain snapshot of used resources.
*
* @see rtems_resource_snapshot_equal() and rtems_resource_snapshot_check().
*
@@ -165,8 +167,8 @@ void rtems_resource_snapshot_take(rtems_resource_snapshot *snapshot);
/**
* @brief Compares two resource snapshots for equality.
*
- * @return Returns true if the resource snapshots are equal, and false
- * otherwise.
+ * @retval true The resource snapshots are equal.
+ * @retval false The resource snapshots are not equal.
*
* @see rtems_resource_snapshot_take().
*/
@@ -179,15 +181,18 @@ bool rtems_resource_snapshot_equal(
* @brief Takes a new resource snapshot and checks that it is equal to the
* given snapshot.
*
- * @param[in] snapshot The snapshot used for comparison with the new snapshot.
+ * @param[in] snapshot is a pointer to the snapshot used for comparison
+ * with the new snapshot.
*
- * @return Returns true if the resource snapshots are equal, and false
- * otherwise.
+ * @retval true The resource snapshots are equal.
+ * @retval false The resource snapshots are not equal.
*
* @see rtems_resource_snapshot_take().
*/
bool rtems_resource_snapshot_check(const rtems_resource_snapshot *snapshot);
+/** @} */
+
#ifdef __cplusplus
}
#endif
diff --git a/cpukit/libcsupport/include/rtems/libio_.h b/cpukit/libcsupport/include/rtems/libio_.h
index c8e91de..80f83f9 100644
--- a/cpukit/libcsupport/include/rtems/libio_.h
+++ b/cpukit/libcsupport/include/rtems/libio_.h
@@ -32,11 +32,11 @@ extern "C" {
#endif
/**
- * @defgroup LibIOInternal IO Internal Library
+ * @defgroup LibIOInternal IO Internal Library
*
- * @brief Internal IO library API and implementation.
+ * @brief Internal IO library API and implementation.
*
- * @{
+ * @{
*/
#define RTEMS_FILESYSTEM_SYMLOOP_MAX 32
@@ -71,8 +71,8 @@ extern rtems_filesystem_mount_table_entry_t rtems_filesystem_null_mt_entry;
* The purpose of this location is to deliver the error return status for a
* previous error condition which must set the errno accordingly.
*
- * The usage of this null location instead of the NULL pointer eliminates a lot
- * of branches.
+ * The usage of this null location instead of the NULL pointer eliminates
+ * a lot of branches.
*
* The user environment root and current directory are statically initialized
* with the null location. Due to that all file system services are in a
@@ -185,8 +185,8 @@ extern rtems_filesystem_global_location_t rtems_filesystem_global_location_null;
*
* The caller must hold the file system instance lock.
*
- * @param[out] clone The cloned location.
- * @param[in] master The master location.
+ * @param[out] clone will contain the cloned location.
+ * @param[in] master is the master location.
*
* @see rtems_filesystem_instance_lock().
*/
@@ -200,9 +200,9 @@ void rtems_filesystem_location_clone(
*
* This function obtains and releases the file system instance lock.
*
- * @param[in] loc The location of the node.
+ * @param[in] loc is the location of the node.
*
- * @return The node type.
+ * @retval type The node type.
*
* @see rtems_filesystem_instance_lock().
*/
@@ -215,9 +215,9 @@ rtems_filesystem_node_types_t rtems_filesystem_node_type(
*
* This function may block on a mutex and may complete an unmount process.
*
- * @param[in] loc The location to free.
+ * @param[in] loc is the location to free.
*
- * @note The file system root location is released by the file system instance
+ * NOTE: The file system root location is released by the file system instance
* destruction handler (see @ref rtems_filesystem_fsunmount_me_t).
*
* @see rtems_filesystem_freenode_t.
@@ -279,24 +279,24 @@ static inline void rtems_filesystem_instance_unlock(
*/
/**
- * This routine searches the IOP Table for an unused entry. If it
- * finds one, it returns it. Otherwise, it returns NULL.
+ * This routine searches the IOP Table for an unused entry. If it
+ * finds one, it returns it. Otherwise, it returns NULL.
*/
rtems_libio_t *rtems_libio_allocate(void);
/**
- * Convert UNIX fnctl(2) flags to ones that RTEMS drivers understand
+ * Convert UNIX fnctl(2) flags to ones that RTEMS drivers understand
*/
uint32_t rtems_libio_fcntl_flags( int fcntl_flags );
/**
- * Convert RTEMS internal flags to UNIX fnctl(2) flags
+ * Convert RTEMS internal flags to UNIX fnctl(2) flags
*/
int rtems_libio_to_fcntl_flags( uint32_t flags );
/**
- * This routine frees the resources associated with an IOP (file descriptor)
- * and clears the slot in the IOP Table.
+ * This routine frees the resources associated with an IOP (file descriptor)
+ * and clears the slot in the IOP Table.
*/
void rtems_libio_free(
rtems_libio_t *iop
@@ -360,8 +360,8 @@ void rtems_filesystem_eval_path_cleanup_with_parent(
* The function obtains the new start location and clones it to set the new
* current location. The previous start and current locations are released.
*
- * @param[in, out] ctx The path evaluation context.
- * @param[in, out] newstartloc_ptr Pointer to new start location.
+ * @param[in, out] ctx is the path evaluation context.
+ * @param[in, out] newstartloc_ptr is a pointer to the new start location.
*/
void rtems_filesystem_eval_path_restart(
rtems_filesystem_eval_path_context_t *ctx,
@@ -377,8 +377,8 @@ typedef enum {
/**
* @brief Tests if the current location is a directory.
*
- * @param[in, out] ctx The path evaluation context.
- * @param[in, out] arg The handler argument.
+ * @param[in, out] ctx is the path evaluation context.
+ * @param[in, out] arg is the handler argument.
*
* @retval true The current location is a directory.
* @retval false Otherwise.
@@ -393,10 +393,10 @@ typedef bool (*rtems_filesystem_eval_path_is_directory)(
/**
* @brief Evaluates a token.
*
- * @param[in, out] ctx The path evaluation context.
- * @param[in, out] arg The handler argument.
- * @param[in] token The token contents.
- * @param[in] tokenlen The token length in characters.
+ * @param[in, out] ctx is the path evaluation context.
+ * @param[in, out] arg is the handler argument.
+ * @param[in] token is the token contents.
+ * @param[in] tokenlen is the token length in characters.
*
* @retval status The generic path evaluation status.
*
@@ -416,7 +416,7 @@ typedef struct {
} rtems_filesystem_eval_path_generic_config;
/**
- * @brief RTEMS File System Eval Generic Path
+ * @brief Evaluates a generic path.
*/
void rtems_filesystem_eval_path_generic(
rtems_filesystem_eval_path_context_t *ctx,
@@ -432,8 +432,8 @@ void rtems_filesystem_initialize(void);
* A bitwise copy is performed. The destination location will be added to the
* corresponding mount entry.
*
- * @param[out] dst The destination location.
- * @param[in] src The source location.
+ * @param[out] dst is the destination location.
+ * @param[in] src is the source location.
*
* @retval dst The destination location.
*
@@ -463,9 +463,10 @@ rtems_filesystem_location_transform_to_global(
/**
* @brief Assigns a global file system location.
*
- * @param[in, out] lhs_global_loc_ptr Pointer to the global left hand side file
- * system location. The current left hand side location will be released.
- * @param[in] rhs_global_loc The global right hand side file system location.
+ * @param[in, out] lhs_global_loc_ptr is a pointer to the global
+ * left hand side file system location. The current left hand side location
+ * will be released.
+ * @param[in] rhs_global_loc is the global right hand side file system location.
*/
void rtems_filesystem_global_location_assign(
rtems_filesystem_global_location_t **lhs_global_loc_ptr,
@@ -480,7 +481,7 @@ void rtems_filesystem_global_location_assign(
* This function must be called from normal thread context and may block on a
* mutex. Thread dispatching is disabled to protect some critical sections.
*
- * @param[in] global_loc_ptr Pointer to the global file system location.
+ * @param[in] global_loc_ptr is a pointer to the global file system location.
*
* @return A global file system location. It returns always a valid object.
* In case of an error, the global null location will be returned. Each
@@ -506,7 +507,8 @@ rtems_filesystem_global_location_t *rtems_filesystem_global_location_obtain(
* sections of the operating system. In this case the release will be
* deferred. The next obtain call will do the actual release.
*
- * @param[in] global_loc The global file system location. It must not be NULL.
+ * @param[in] global_loc is the global file system location. It must not
+ * be NULL.
*
* @see rtems_filesystem_global_location_obtain().
*/
@@ -555,7 +557,7 @@ static inline void rtems_filesystem_location_error(
}
}
/**
- * @brief RTEMS File System Mknod
+ * @brief Create a file.
*/
int rtems_filesystem_mknod(
const rtems_filesystem_location_info_t *parentloc,
@@ -568,7 +570,7 @@ int rtems_filesystem_mknod(
int rtems_filesystem_chdir( rtems_filesystem_location_info_t *loc );
/**
- * @brief Change Owner and Group of a File
+ * @brief Change the owner and the group of a file.
*/
int rtems_filesystem_chown(
const char *path,
@@ -700,7 +702,7 @@ static inline void rtems_filesystem_eval_path_put_back_token(
}
/**
- * @brief RTEMS File System Eval Eat Delimiter Path
+ * @brief Evaluates an eat delimiter path.
*/
void rtems_filesystem_eval_path_eat_delimiter(
rtems_filesystem_eval_path_context_t *ctx
diff --git a/cpukit/libcsupport/include/sys/statvfs.h b/cpukit/libcsupport/include/sys/statvfs.h
index 8872670..eccc7d2 100644
--- a/cpukit/libcsupport/include/sys/statvfs.h
+++ b/cpukit/libcsupport/include/sys/statvfs.h
@@ -1,12 +1,12 @@
/**
- * @file sys/statvfs.h
+ * @file
*
- * @brief Interface to the statvfs() set of API Methods
+ * @brief Interface to the statvfs() Set of API Methods
*
* This include file defines the interface to the statvfs() set of
* API methods. The statvfs as defined by the SUS:
*
- * - http://www.opengroup.org/onlinepubs/009695399/basedefs/sys/statvfs.h.html
+ * - http://www.opengroup.org/onlinepubs/009695399/basedefs/sys/statvfs.h.html
*/
/*
diff --git a/cpukit/libcsupport/include/sys/termios.h b/cpukit/libcsupport/include/sys/termios.h
index cc84408..5b96814 100644
--- a/cpukit/libcsupport/include/sys/termios.h
+++ b/cpukit/libcsupport/include/sys/termios.h
@@ -1,7 +1,7 @@
/**
- * @file sys/termios.h
+ * @file
*
- * @brief POSIX termios Implementation for RTEMS Console Device Driver
+ * @brief POSIX Termios Implementation for RTEMS Console Device Driver
*
* The Open Group Base Specifications Issue 6
* IEEE Std 1003.1, 2004 Edition
@@ -27,9 +27,11 @@ extern "C" {
#endif
/**
- * @ingroup Termios
+ * @ingroup Termios
*
- * @brief POSIX Termios Implementation
+ * @brief POSIX Termios Implementation
+ *
+ * @{
*/
typedef unsigned char cc_t;
@@ -47,8 +49,8 @@ struct termios {
};
/**
- * This value is used to disable processing of a member of c_cc
- * in the struct termios.
+ * This value is used to disable processing of a member of c_cc
+ * in the struct termios.
*/
#define _POSIX_VDISABLE 0
@@ -208,6 +210,8 @@ int cfsetospeed(struct termios *tp, speed_t speed);
speed_t cfgetispeed(const struct termios *tp);
int cfsetispeed(struct termios *tp, speed_t speed);
+/** @} */
+
#ifdef __cplusplus
}
#endif
diff --git a/cpukit/libcsupport/include/sys/utsname.h b/cpukit/libcsupport/include/sys/utsname.h
index df3cc67..93d3316 100644
--- a/cpukit/libcsupport/include/sys/utsname.h
+++ b/cpukit/libcsupport/include/sys/utsname.h
@@ -1,5 +1,5 @@
/**
- * @file sys/utsname.h
+ * @file
*
* @brief Interface to the POSIX utsname() Service
*
@@ -19,9 +19,10 @@
#define __POSIX_SYS_UTSNAME_h
/**
- * @defgroup utsname Service
+ * @defgroup utsname Service
+ *
+ * @{
*/
-/**@{*/
#ifdef __cplusplus
extern "C" {
@@ -55,15 +56,19 @@ struct utsname {
};
/**
- * @brief 4.4.1 Get System Name, P1003.1b-1993, p. 90
+ * @brief Get system name.
+ *
+ * 4.4.1 Get System Name, P1003.1b-1993, p. 90
*/
int uname(
struct utsname *name
);
+/** @} */
+
#ifdef __cplusplus
}
#endif
-/**@}*/
+
#endif
/* end of include file */
diff --git a/cpukit/libcsupport/include/timerdrv.h b/cpukit/libcsupport/include/timerdrv.h
index b5eb6a1..ad74bc6 100644
--- a/cpukit/libcsupport/include/timerdrv.h
+++ b/cpukit/libcsupport/include/timerdrv.h
@@ -1,5 +1,5 @@
/**
- * @file rtems/timerdrv.h
+ * @file
*
* @brief Timer Driver for all Boards
*
diff --git a/cpukit/libcsupport/include/vmeintr.h b/cpukit/libcsupport/include/vmeintr.h
index 4fdc8ac..db1bf4d 100644
--- a/cpukit/libcsupport/include/vmeintr.h
+++ b/cpukit/libcsupport/include/vmeintr.h
@@ -3,9 +3,9 @@
*
* @brief VMEbus Interface Library
*
- * This file is the specification for the VMEbus interface library
- * which should be provided by all BSPs for VMEbus Single Board
- * Computers but currently only a few do so.
+ * This file is the specification for the VMEbus interface library
+ * which should be provided by all BSPs for VMEbus Single Board
+ * Computers but currently only a few do so.
*/
/*
diff --git a/cpukit/libcsupport/include/zilog/z8036.h b/cpukit/libcsupport/include/zilog/z8036.h
index 0e585e1..686787d 100644
--- a/cpukit/libcsupport/include/zilog/z8036.h
+++ b/cpukit/libcsupport/include/zilog/z8036.h
@@ -1,5 +1,5 @@
/**
- * @file rtems/zilog/z8036.h
+ * @file
*
* @brief Zilog Z8036 Counter/Timer/IO Chip
*
diff --git a/cpukit/libcsupport/include/zilog/z8530.h b/cpukit/libcsupport/include/zilog/z8530.h
index d11698d..8fd9f39 100644
--- a/cpukit/libcsupport/include/zilog/z8530.h
+++ b/cpukit/libcsupport/include/zilog/z8530.h
@@ -1,10 +1,10 @@
/**
- * @file rtems/zilog/z8530.h
+ * @file
*
* @brief Information Related to a Zilog Z8530 SCC Chip
*
- * This include file defines information related to a Zilog Z8530
- * SCC Chip. It is a IO mapped part.
+ * This include file defines information related to a Zilog Z8530
+ * SCC Chip. It is a IO mapped part.
*/
/*
diff --git a/cpukit/libcsupport/include/zilog/z8536.h b/cpukit/libcsupport/include/zilog/z8536.h
index 326e755..1970fb1 100644
--- a/cpukit/libcsupport/include/zilog/z8536.h
+++ b/cpukit/libcsupport/include/zilog/z8536.h
@@ -1,5 +1,5 @@
/**
- * @file rtems/zilog/z8536.h
+ * @file
*
* @brief Information Related to a Zilog Z8536 Counter/Timer/IO Chip
*
More information about the vc
mailing list