[rtems commit] libcsupport: Doxygen enhancement GCI task #4
Gedare Bloom
gedare at rtems.org
Tue Dec 11 21:46:58 UTC 2012
Module: rtems
Branch: master
Commit: 17c6ad6a01a7ace26decff61b20bdada797ed782
Changeset: http://git.rtems.org/rtems/commit/?id=17c6ad6a01a7ace26decff61b20bdada797ed782
Author: Alex Ivanov <alexivanov97 at gmail.com>
Date: Tue Dec 11 16:51:08 2012 -0500
libcsupport: Doxygen enhancement GCI task #4
http://www.google-melange.com/gci/task/view/google/gci2012/8009205
---
cpukit/libcsupport/include/rtems/assoc.h | 3 +
cpukit/libcsupport/include/rtems/error.h | 61 ++++++++++++++++++++
cpukit/libcsupport/include/rtems/libio_.h | 13 +++--
cpukit/libcsupport/include/rtems/malloc.h | 3 +
cpukit/libcsupport/include/rtems/termiostypes.h | 12 ++--
cpukit/libcsupport/include/sys/termios.h | 10 +++
cpukit/libcsupport/src/assocptrbylocal.c | 8 ++-
cpukit/libcsupport/src/chmod.c | 12 +++-
cpukit/libcsupport/src/chown.c | 12 +++-
cpukit/libcsupport/src/error.c | 55 ++----------------
cpukit/libcsupport/src/flockfile.c | 10 +++-
cpukit/libcsupport/src/getdents.c | 22 +++++---
cpukit/libcsupport/src/getpid.c | 19 ++++---
cpukit/libcsupport/src/getpwent.c | 29 ++++++---
cpukit/libcsupport/src/mkdir.c | 12 +++-
cpukit/libcsupport/src/printf_plugin.c | 7 ++
cpukit/libcsupport/src/printk_plugin.c | 7 ++
cpukit/libcsupport/src/read.c | 21 ++++---
.../libcsupport/src/rtems_heap_extend_via_sbrk.c | 7 ++
cpukit/libcsupport/src/sup_fs_eval_path.c | 7 ++
cpukit/libcsupport/src/sup_fs_node_type.c | 7 ++
cpukit/libcsupport/src/tcgetattr.c | 9 ++-
cpukit/libcsupport/src/tcsendbreak.c | 9 ++-
cpukit/libcsupport/src/termios_baud2num.c | 7 ++
cpukit/libcsupport/src/termios_baudtable.c | 7 ++
cpukit/libcsupport/src/unlink.c | 21 ++++---
26 files changed, 274 insertions(+), 116 deletions(-)
diff --git a/cpukit/libcsupport/include/rtems/assoc.h b/cpukit/libcsupport/include/rtems/assoc.h
index 9264560..496ddb4 100644
--- a/cpukit/libcsupport/include/rtems/assoc.h
+++ b/cpukit/libcsupport/include/rtems/assoc.h
@@ -115,6 +115,9 @@ uint32_t rtems_assoc_local_by_remote_bitfield(
uint32_t
);
+/**
+ * @brief RTEMS Associate Pointer by Local
+ */
const rtems_assoc_t *rtems_assoc_ptr_by_local(
const rtems_assoc_t *ap,
uint32_t local_value
diff --git a/cpukit/libcsupport/include/rtems/error.h b/cpukit/libcsupport/include/rtems/error.h
index ab23ab0..056fb8f 100644
--- a/cpukit/libcsupport/include/rtems/error.h
+++ b/cpukit/libcsupport/include/rtems/error.h
@@ -2,6 +2,40 @@
* @file rtems/error.h
*
* Defines and externs for rtems error reporting
+ *
+ * Currently just used by RTEMS monitor.
+ *
+ * These routines provide general purpose error reporting.
+ * rtems_error reports an error to stderr and allows use of
+ * printf style formatting. A newline is appended to all messages.
+ *
+ * error_flag can be specified as any of the following:
+ *
+ * RTEMS_ERROR_ERRNO -- include errno text in output
+ * RTEMS_ERROR_PANIC -- halts local system after output
+ * RTEMS_ERROR_ABORT -- abort after output
+ *
+ * It can also include a rtems_status value which can be OR'd
+ * with the above flags. *
+ *
+ * EXAMPLE
+ * #include <rtems.h>
+ * #include <rtems/error.h>
+ * rtems_error(0, "stray interrupt %d", intr);
+ *
+ * EXAMPLE
+ * if ((status = rtems_task_create(...)) != RTEMS_SUCCCESSFUL)
+ * {
+ * rtems_error(status | RTEMS_ERROR_ABORT,
+ * "could not create task");
+ * }
+ *
+ * EXAMPLE
+ * if ((fd = open(pathname, O_RDNLY)) < 0)
+ * {
+ * rtems_error(RTEMS_ERROR_ERRNO, "open of '%s' failed", pathname);
+ * goto failed;
+ * }
*/
@@ -15,6 +49,15 @@
extern "C" {
#endif
+/**
+ * @defgroup ErrorPanicSupport Error And Panic Support
+ *
+ * @ingroup libcsupport
+ *
+ * @brief Defines and externs for rtems error reporting
+ *
+ */
+
typedef Internal_errors_t rtems_error_code_t;
/*
@@ -36,11 +79,29 @@ typedef Internal_errors_t rtems_error_code_t;
(RTEMS_ERROR_ERRNO | RTEMS_ERROR_ABORT | RTEMS_ERROR_PANIC) /* all */
const char *rtems_status_text(rtems_status_code sc);
+
+/**
+ * @brief Report an Error
+ *
+ * @param[in] error_code can be specified as any of the following:
+ * RTEMS_ERROR_ERRNO -- include errno text in output
+ * RTEMS_ERROR_PANIC -- halts local system after output
+ * RTEMS_ERROR_ABORT -- abort after output
+ *
+ * @param[in] printf_format is a normal printf(3) format string,
+ * with its concommitant arguments
+ *
+ * @return the number of characters written.
+ */
int rtems_error(
rtems_error_code_t error_code,
const char *printf_format,
...
);
+
+/**
+ * rtems_panic is shorthand for rtems_error(RTEMS_ERROR_PANIC, ...)
+ */
void rtems_panic(
const char *printf_format,
...
diff --git a/cpukit/libcsupport/include/rtems/libio_.h b/cpukit/libcsupport/include/rtems/libio_.h
index d6d7ddf..19b8661 100644
--- a/cpukit/libcsupport/include/rtems/libio_.h
+++ b/cpukit/libcsupport/include/rtems/libio_.h
@@ -194,15 +194,15 @@ void rtems_filesystem_location_clone(
);
/**
- * @brief Returns the type of a node.
+ * @brief Returns the Type of a Node
*
- * This function obtains and releases the file system instance lock.
+ * This function obtains and releases the file system instance lock.
*
- * @param[in] loc The location of the node.
+ * @param[in] loc The location of the node.
*
- * @return The node type.
+ * @return The node type.
*
- * @see rtems_filesystem_instance_lock().
+ * @see rtems_filesystem_instance_lock().
*/
rtems_filesystem_node_types_t rtems_filesystem_node_type(
const rtems_filesystem_location_info_t *loc
@@ -551,6 +551,9 @@ int rtems_filesystem_mknod(
int rtems_filesystem_chdir( rtems_filesystem_location_info_t *loc );
+/**
+ * @brief Change Owner and Group of a File
+ */
int rtems_filesystem_chown(
const char *path,
uid_t owner,
diff --git a/cpukit/libcsupport/include/rtems/malloc.h b/cpukit/libcsupport/include/rtems/malloc.h
index 6b0dfa0..fdb57f3 100644
--- a/cpukit/libcsupport/include/rtems/malloc.h
+++ b/cpukit/libcsupport/include/rtems/malloc.h
@@ -88,6 +88,9 @@ typedef void *(*rtems_heap_extend_handler)(
size_t alloc_size
);
+/**
+ * @brief RTEMS Extend Heap via Sbrk
+ */
void *rtems_heap_extend_via_sbrk(
Heap_Control *heap,
size_t alloc_size
diff --git a/cpukit/libcsupport/include/rtems/termiostypes.h b/cpukit/libcsupport/include/rtems/termiostypes.h
index 7f2a3ea..89a997a 100644
--- a/cpukit/libcsupport/include/rtems/termiostypes.h
+++ b/cpukit/libcsupport/include/rtems/termiostypes.h
@@ -191,6 +191,9 @@ extern int rtems_termios_nlinesw;
/* baudrate xxx integer type */
typedef uint32_t rtems_termios_baud_t;
+/**
+ * @brief RTEMS Termios Baud Table
+ */
extern const rtems_assoc_t rtems_termios_baud_table [];
/**
@@ -203,13 +206,12 @@ extern const rtems_assoc_t rtems_termios_baud_table [];
tcflag_t rtems_termios_number_to_baud(rtems_termios_baud_t baud);
/**
- * @brief Converts the baud part of the Termios control flags @a c_cflag to an
- * integral baud value.
+ * @brief Convert Baud Part of Termios control flags to an integral Baud Value
*
- * There is no need to mask the @a c_cflag with @c CBAUD.
+ * There is no need to mask the @a c_cflag with @c CBAUD.
*
- * @retval 0 Invalid baud value or a baud value of @c B0.
- * @retval other Integral baud value.
+ * @retval 0 Invalid baud value or a baud value of @c B0.
+ * @retval other Integral baud value.
*/
rtems_termios_baud_t rtems_termios_baud_to_number(tcflag_t c_cflag);
diff --git a/cpukit/libcsupport/include/sys/termios.h b/cpukit/libcsupport/include/sys/termios.h
index b65f81d..f51cd3c 100644
--- a/cpukit/libcsupport/include/sys/termios.h
+++ b/cpukit/libcsupport/include/sys/termios.h
@@ -198,11 +198,21 @@ int tcdrain(int);
*/
int tcflow(int, int);
int tcflush(int, int);
+
+/**
+ * @brief Get State
+ * POSIX 1003.1b 7.2.1 - Get and Set State
+ */
int tcgetattr(int, struct termios *);
int tcsetattr(int, int, struct termios *);
int tcdrain(int);
pid_t tcgetprgrp(int);
int tcsetprgrp(int, pid_t);
+
+/**
+ * @brief Line Control Functions
+ * POSIX 1003.1b 7.2.2 - Line Control Functions
+ */
int tcsendbreak(int, int);
/**
diff --git a/cpukit/libcsupport/src/assocptrbylocal.c b/cpukit/libcsupport/src/assocptrbylocal.c
index 8cba79c..a0e7c3c 100644
--- a/cpukit/libcsupport/src/assocptrbylocal.c
+++ b/cpukit/libcsupport/src/assocptrbylocal.c
@@ -1,6 +1,8 @@
-/*
- * assoc.c
- * rtems assoc routines
+/**
+ * @file
+ *
+ * @brief RTEMS Associate Pointer by Local
+ * @ingroup Associativity
*/
#if HAVE_CONFIG_H
diff --git a/cpukit/libcsupport/src/chmod.c b/cpukit/libcsupport/src/chmod.c
index 47de601..8b91b60 100644
--- a/cpukit/libcsupport/src/chmod.c
+++ b/cpukit/libcsupport/src/chmod.c
@@ -1,6 +1,11 @@
-/*
- * chmod() - POSIX 1003.1b 5.6.4 - Change File Modes
+/**
+ * @file
*
+ * @brief Change File Modes
+ * @ingroup libcsupport
+ */
+
+/*
* COPYRIGHT (c) 1989-1999.
* On-Line Applications Research Corporation (OAR).
*
@@ -17,6 +22,9 @@
#include <rtems/libio_.h>
+/**
+ * POSIX 1003.1b 5.6.4 - Change File Modes
+ */
int chmod( const char *path, mode_t mode )
{
int rv = 0;
diff --git a/cpukit/libcsupport/src/chown.c b/cpukit/libcsupport/src/chown.c
index 7cc03a2..434fc2b 100644
--- a/cpukit/libcsupport/src/chown.c
+++ b/cpukit/libcsupport/src/chown.c
@@ -1,6 +1,11 @@
-/*
- * chown() - POSIX 1003.1b 5.6.5 - Change Owner and Group of a File
+/**
+ * @file
*
+ * @brief Change Owner and Group of a File
+ * @ingroup libcsupport
+ */
+
+/*
* COPYRIGHT (c) 1989-1999.
* On-Line Applications Research Corporation (OAR).
*
@@ -41,6 +46,9 @@ int rtems_filesystem_chown(
return rv;
}
+/**
+ * POSIX 1003.1b 5.6.5 - Change Owner and Group of a File
+ */
int chown( const char *path, uid_t owner, gid_t group )
{
return rtems_filesystem_chown( path, owner, group, RTEMS_FS_FOLLOW_LINK );
diff --git a/cpukit/libcsupport/src/error.c b/cpukit/libcsupport/src/error.c
index f8d2e40..a77dfbb 100644
--- a/cpukit/libcsupport/src/error.c
+++ b/cpukit/libcsupport/src/error.c
@@ -1,46 +1,14 @@
-/*
- * report errors and panics to RTEMS' stderr.
- * Currently just used by RTEMS monitor.
+/**
+ * @file
+ *
+ * @brief Error and Panic Report Support
+ * @ingroup ErrorPanicSupport
*/
#if HAVE_CONFIG_H
#include "config.h"
#endif
-/*
- * These routines provide general purpose error reporting.
- * rtems_error reports an error to stderr and allows use of
- * printf style formatting. A newline is appended to all messages.
- *
- * error_flag can be specified as any of the following:
- *
- * RTEMS_ERROR_ERRNO -- include errno text in output
- * RTEMS_ERROR_PANIC -- halts local system after output
- * RTEMS_ERROR_ABORT -- abort after output
- *
- * It can also include a rtems_status value which can be OR'd
- * with the above flags. *
- *
- * EXAMPLE
- * #include <rtems.h>
- * #include <rtems/error.h>
- * rtems_error(0, "stray interrupt %d", intr);
- *
- * EXAMPLE
- * if ((status = rtems_task_create(...)) != RTEMS_SUCCCESSFUL)
- * {
- * rtems_error(status | RTEMS_ERROR_ABORT,
- * "could not create task");
- * }
- *
- * EXAMPLE
- * if ((fd = open(pathname, O_RDNLY)) < 0)
- * {
- * rtems_error(RTEMS_ERROR_ERRNO, "open of '%s' failed", pathname);
- * goto failed;
- * }
- */
-
/* This is always defined on RTEMS Scheduler Simulator and thus
* we get a redefined warning if this is not present.
*/
@@ -153,15 +121,6 @@ static int rtems_verror(
return chars_written;
}
-
-/*
- * Report an error.
- * error_flag is as above; printf_format is a normal
- * printf(3) format string, with its concommitant arguments.
- *
- * Returns the number of characters written.
- */
-
int rtems_error(
rtems_error_code_t error_flag,
const char *printf_format,
@@ -187,10 +146,6 @@ int rtems_error(
return chars_written;
}
-/*
- * rtems_panic is shorthand for rtems_error(RTEMS_ERROR_PANIC, ...)
- */
-
void rtems_panic(
const char *printf_format,
...
diff --git a/cpukit/libcsupport/src/flockfile.c b/cpukit/libcsupport/src/flockfile.c
index 5fc6e25..b4c28d8 100644
--- a/cpukit/libcsupport/src/flockfile.c
+++ b/cpukit/libcsupport/src/flockfile.c
@@ -1,3 +1,9 @@
+/**
+ * @file
+ *
+ * @brief Lock File for Stdio
+ * @ingroup SET
+ */
/*
* Copyright (c) 2009 by
* Ralf Corsépius, Ulm, Germany. All rights reserved.
@@ -14,7 +20,9 @@
#include <stdio.h>
-/* This is a non-functional stub */
+/**
+ * This is a non-functional stub
+ */
void flockfile(FILE* file __attribute__((unused)))
{
}
diff --git a/cpukit/libcsupport/src/getdents.c b/cpukit/libcsupport/src/getdents.c
index 4f68240..9e26a3c 100644
--- a/cpukit/libcsupport/src/getdents.c
+++ b/cpukit/libcsupport/src/getdents.c
@@ -1,12 +1,11 @@
-/*
- * getdents() - Get Directory Entries
- *
- * SVR4 and SVID extension required by Newlib readdir() family.
- *
- * This routine will dd_len / (sizeof dirent) directory entries relative to
- * the current directory position index. These entries will be placed in
- * character array pointed to by -dd_buf-
+/**
+ * @file
*
+ * @brief Get Directory Entries
+ * @ingroup libcsupport
+ */
+
+/*
* COPYRIGHT (c) 1989-1999.
* On-Line Applications Research Corporation (OAR).
*
@@ -24,6 +23,13 @@
#include <rtems/libio_.h>
#include <rtems/seterr.h>
+/**
+ * SVR4 and SVID extension required by Newlib readdir() family.
+ *
+ * This routine will dd_len / (sizeof dirent) directory entries relative to
+ * the current directory position index. These entries will be placed in
+ * character array pointed to by -dd_buf-
+ */
int getdents(
int dd_fd,
char *dd_buf,
diff --git a/cpukit/libcsupport/src/getpid.c b/cpukit/libcsupport/src/getpid.c
index a46fbb5..27825e5 100644
--- a/cpukit/libcsupport/src/getpid.c
+++ b/cpukit/libcsupport/src/getpid.c
@@ -1,3 +1,10 @@
+/**
+ * @file
+ *
+ * @brief Process and Parent Process IDs
+ * @ingroup libcsupport
+ */
+
#if HAVE_CONFIG_H
#include "config.h"
#endif
@@ -8,25 +15,21 @@
#include <rtems/score/object.h>
#include <rtems/seterr.h>
-/*
+/**
* 4.1.1 Get Process and Parent Process IDs, P1003.1b-1993, p. 83
*/
-
pid_t getpid( void )
{
return _Objects_Local_node;
}
-/*
- * _getpid_r
- *
- * This is the Newlib dependent reentrant version of getpid().
- */
-
#if defined(RTEMS_NEWLIB) && !defined(HAVE__GETPID_R)
#include <reent.h>
+/**
+ * This is the Newlib dependent reentrant version of getpid().
+ */
pid_t _getpid_r(
struct _reent *ptr __attribute__((unused))
)
diff --git a/cpukit/libcsupport/src/getpwent.c b/cpukit/libcsupport/src/getpwent.c
index 75181fd..618f318 100644
--- a/cpukit/libcsupport/src/getpwent.c
+++ b/cpukit/libcsupport/src/getpwent.c
@@ -1,6 +1,11 @@
-/*
- * POSIX 1003.1b - 9.2.2 - User Database Access Routines
+/**
+ * @file
*
+ * @brief User Database Access Routines
+ * @ingroup libcsupport
+ */
+
+/*
* The license and distribution terms for this file may be
* found in the file LICENSE in this distribution or at
* http://www.rtems.com/license/LICENSE.
@@ -24,6 +29,10 @@
#include <rtems/libio_.h>
#include <rtems/seterr.h>
+/**
+ * POSIX 1003.1b - 9.2.2 - User Database Access Routines
+ */
+
/*
* Static, thread-unsafe, buffers
*/
@@ -34,8 +43,8 @@ static FILE *group_fp;
static char grbuf[200];
static struct group grent;
-/*
- * Initialize useable but dummy databases
+/**
+ * Initialize useable but dummy databases
*/
void init_etc_passwd_group(void)
{
@@ -74,8 +83,8 @@ void init_etc_passwd_group(void)
}
}
-/*
- * Extract a string value from the database
+/**
+ * Extract a string value from the database
*/
static int
scanString(FILE *fp, char **name, char **bufp, size_t *nleft, int nlFlag)
@@ -109,8 +118,8 @@ scanString(FILE *fp, char **name, char **bufp, size_t *nleft, int nlFlag)
return 1;
}
-/*
- * Extract an integer value from the database
+/**
+ * Extract an integer value from the database
*/
static int
scanInt(FILE *fp, int *val)
@@ -279,8 +288,8 @@ void endpwent(void)
fclose(passwd_fp);
}
-/*
- * Extract a single group record from the database
+/**
+ * Extract a single group record from the database
*/
static int scangr(
FILE *fp,
diff --git a/cpukit/libcsupport/src/mkdir.c b/cpukit/libcsupport/src/mkdir.c
index 7b82314..e1c4b7c 100644
--- a/cpukit/libcsupport/src/mkdir.c
+++ b/cpukit/libcsupport/src/mkdir.c
@@ -1,6 +1,11 @@
-/*
- * mkdir() - POSIX 1003.1b 5.4.1 - Make a Directory
+/**
+ * @file
*
+ * @brief Make a Directory
+ * @ingroup libcsupport
+ */
+
+/*
* COPYRIGHT (c) 1989-1999.
* On-Line Applications Research Corporation (OAR).
*
@@ -19,6 +24,9 @@
#include <errno.h>
#include <stdlib.h>
+/**
+ * POSIX 1003.1b 5.4.1 - Make a Directory
+ */
int mkdir(
const char *pathname,
mode_t mode
diff --git a/cpukit/libcsupport/src/printf_plugin.c b/cpukit/libcsupport/src/printf_plugin.c
index 8791327..5814f6e 100644
--- a/cpukit/libcsupport/src/printf_plugin.c
+++ b/cpukit/libcsupport/src/printf_plugin.c
@@ -1,3 +1,10 @@
+/**
+ * @file
+ *
+ * @brief RTEMS Plugin Printf
+ * @ingroup libcsupport
+ */
+
/*
* Copyright (c) 2012 embedded brains GmbH. All rights reserved.
*
diff --git a/cpukit/libcsupport/src/printk_plugin.c b/cpukit/libcsupport/src/printk_plugin.c
index 70fd19a..12f9495 100644
--- a/cpukit/libcsupport/src/printk_plugin.c
+++ b/cpukit/libcsupport/src/printk_plugin.c
@@ -1,3 +1,10 @@
+/**
+ * @file
+ *
+ * @brief Plugin Printk
+ * @ingroup libcsupport
+ */
+
/*
* COPYRIGHT (c) 1989-2007.
* On-Line Applications Research Corporation (OAR).
diff --git a/cpukit/libcsupport/src/read.c b/cpukit/libcsupport/src/read.c
index ee10166..c1a0d08 100644
--- a/cpukit/libcsupport/src/read.c
+++ b/cpukit/libcsupport/src/read.c
@@ -1,6 +1,11 @@
-/*
- * read() - POSIX 1003.1b 6.4.1 - Read From a File
+/**
+ * @file
*
+ * @brief Read From a File
+ * @ingroup libcsupport
+ */
+
+/*
* COPYRIGHT (c) 1989-2011.
* On-Line Applications Research Corporation (OAR).
*
@@ -16,6 +21,9 @@
#include <rtems/libio_.h>
#include <rtems/seterr.h>
+/**
+ * POSIX 1003.1b 6.4.1 - Read From a File
+ */
ssize_t read(
int fd,
void *buffer,
@@ -37,16 +45,13 @@ ssize_t read(
return (*iop->pathinfo.handlers->read_h)( iop, buffer, count );
}
-/*
- * _read_r
- *
- * This is the Newlib dependent reentrant version of read().
- */
-
#if defined(RTEMS_NEWLIB) && !defined(HAVE__READ_R)
#include <reent.h>
+/**
+ * This is the Newlib dependent reentrant version of read().
+ */
ssize_t _read_r(
struct _reent *ptr __attribute__((unused)),
int fd,
diff --git a/cpukit/libcsupport/src/rtems_heap_extend_via_sbrk.c b/cpukit/libcsupport/src/rtems_heap_extend_via_sbrk.c
index 831626b..d27a366 100644
--- a/cpukit/libcsupport/src/rtems_heap_extend_via_sbrk.c
+++ b/cpukit/libcsupport/src/rtems_heap_extend_via_sbrk.c
@@ -1,3 +1,10 @@
+/**
+ * @file
+ *
+ * @brief RTEMS Extend Heap via Sbrk
+ * @ingroup MallocSupport
+ */
+
/*
* Copyright (c) 2012 embedded brains GmbH. All rights reserved.
*
diff --git a/cpukit/libcsupport/src/sup_fs_eval_path.c b/cpukit/libcsupport/src/sup_fs_eval_path.c
index f323dbc..ca31e5e 100644
--- a/cpukit/libcsupport/src/sup_fs_eval_path.c
+++ b/cpukit/libcsupport/src/sup_fs_eval_path.c
@@ -1,3 +1,10 @@
+/**
+ * @file
+ *
+ * @brief RTEMS File Sysyem Path Eval Support
+ * @ingroup LibIOInternal
+ */
+
/*
* Copyright (c) 2012 embedded brains GmbH. All rights reserved.
*
diff --git a/cpukit/libcsupport/src/sup_fs_node_type.c b/cpukit/libcsupport/src/sup_fs_node_type.c
index 0eb4221..561075c 100644
--- a/cpukit/libcsupport/src/sup_fs_node_type.c
+++ b/cpukit/libcsupport/src/sup_fs_node_type.c
@@ -1,3 +1,10 @@
+/**
+ * @file
+ *
+ * @brief Returns the Type of a Node
+ * @ingroup LibIOInternal
+ */
+
/*
* Copyright (c) 2012 embedded brains GmbH. All rights reserved.
*
diff --git a/cpukit/libcsupport/src/tcgetattr.c b/cpukit/libcsupport/src/tcgetattr.c
index 00964d2..281e756 100644
--- a/cpukit/libcsupport/src/tcgetattr.c
+++ b/cpukit/libcsupport/src/tcgetattr.c
@@ -1,6 +1,11 @@
-/*
- * tcgetattr() - POSIX 1003.1b 7.2.1 - Get and Set State
+/**
+ * @file
*
+ * @brief Get State
+ * @ingroup Termios
+ */
+
+/*
* COPYRIGHT (c) 1989-1999.
* On-Line Applications Research Corporation (OAR).
*
diff --git a/cpukit/libcsupport/src/tcsendbreak.c b/cpukit/libcsupport/src/tcsendbreak.c
index 43ebcaa..11ac828 100644
--- a/cpukit/libcsupport/src/tcsendbreak.c
+++ b/cpukit/libcsupport/src/tcsendbreak.c
@@ -1,6 +1,11 @@
-/*
- * tcsendbreak() - POSIX 1003.1b 7.2.2 - Line Control Functions
+/**
+ * @file
*
+ * @brief Line Control Functions
+ * @ingroup Termios
+ */
+
+/*
* COPYRIGHT (c) 1989-1999.
* On-Line Applications Research Corporation (OAR).
*
diff --git a/cpukit/libcsupport/src/termios_baud2num.c b/cpukit/libcsupport/src/termios_baud2num.c
index 1da2f37..770e670 100644
--- a/cpukit/libcsupport/src/termios_baud2num.c
+++ b/cpukit/libcsupport/src/termios_baud2num.c
@@ -1,3 +1,10 @@
+/**
+ * @file
+ *
+ * @brief Convert Baud Part of Termios control flags to an integral Baud Value
+ * @ingroup TermiostypesSupport
+ */
+
/*
* COPYRIGHT (c) 1989-2008.
* On-Line Applications Research Corporation (OAR).
diff --git a/cpukit/libcsupport/src/termios_baudtable.c b/cpukit/libcsupport/src/termios_baudtable.c
index d1d70cb..a3c0b78 100644
--- a/cpukit/libcsupport/src/termios_baudtable.c
+++ b/cpukit/libcsupport/src/termios_baudtable.c
@@ -1,3 +1,10 @@
+/**
+ * @file
+ *
+ * @brief RTEMS Termios Baud Table
+ * @ingroup TermiostypesSupport
+ */
+
/*
* COPYRIGHT (c) 1989-2010.
* On-Line Applications Research Corporation (OAR).
diff --git a/cpukit/libcsupport/src/unlink.c b/cpukit/libcsupport/src/unlink.c
index a007cc2..dbeacf4 100644
--- a/cpukit/libcsupport/src/unlink.c
+++ b/cpukit/libcsupport/src/unlink.c
@@ -1,6 +1,11 @@
-/*
- * unlink() - POSIX 1003.1b - 5.5.1 - Remove an existing link
+/**
+ * @file
*
+ * @brief Remove an Existing Link
+ * @ingroup libcsupport
+ */
+
+/*
* COPYRIGHT (c) 1989-1999.
* On-Line Applications Research Corporation (OAR).
*
@@ -17,6 +22,9 @@
#include <rtems/libio_.h>
+/**
+ * POSIX 1003.1b - 5.5.1 - Remove an existing link
+ */
int unlink( const char *path )
{
int rv = 0;
@@ -49,16 +57,13 @@ int unlink( const char *path )
return rv;
}
-/*
- * _unlink_r
- *
- * This is the Newlib dependent reentrant version of unlink().
- */
-
#if defined(RTEMS_NEWLIB)
#include <reent.h>
+/**
+ * This is the Newlib dependent reentrant version of unlink().
+ */
int _unlink_r(
struct _reent *ptr __attribute__((unused)),
const char *path
More information about the vc
mailing list