diff options
author | Mathew Kallada <matkallada@gmail.com> | 2012-12-08 15:43:29 -0500 |
---|---|---|
committer | Gedare Bloom <gedare@rtems.org> | 2012-12-08 15:43:29 -0500 |
commit | ceaa99964fee5138ebec4b09b80fdf13c3407cfa (patch) | |
tree | ce1b9891c9061e6378acdc9e85d025d0afb895a6 /cpukit/libcsupport/src | |
parent | misc rtems: Clean up Doxygen GCI Task #8 (diff) | |
download | rtems-ceaa99964fee5138ebec4b09b80fdf13c3407cfa.tar.bz2 |
libcsupport: Doxygen Enhancement Task #3
http://www.google-melange.com/gci/task/view/google/gci2012/7992210
Diffstat (limited to 'cpukit/libcsupport/src')
-rw-r--r-- | cpukit/libcsupport/src/_realloc_r.c | 9 | ||||
-rw-r--r-- | cpukit/libcsupport/src/access.c | 9 | ||||
-rw-r--r-- | cpukit/libcsupport/src/assoclocalbyname.c | 15 | ||||
-rw-r--r-- | cpukit/libcsupport/src/assocremotebylocalbitfield.c | 15 | ||||
-rw-r--r-- | cpukit/libcsupport/src/chdir.c | 9 | ||||
-rw-r--r-- | cpukit/libcsupport/src/chroot.c | 8 | ||||
-rw-r--r-- | cpukit/libcsupport/src/close.c | 9 | ||||
-rw-r--r-- | cpukit/libcsupport/src/dup.c | 9 | ||||
-rw-r--r-- | cpukit/libcsupport/src/fcntl.c | 9 | ||||
-rw-r--r-- | cpukit/libcsupport/src/fdatasync.c | 9 | ||||
-rw-r--r-- | cpukit/libcsupport/src/free.c | 9 | ||||
-rw-r--r-- | cpukit/libcsupport/src/getcwd.c | 7 | ||||
-rw-r--r-- | cpukit/libcsupport/src/ioctl.c | 9 | ||||
-rw-r--r-- | cpukit/libcsupport/src/kill_noposix.c | 11 | ||||
-rw-r--r-- | cpukit/libcsupport/src/posix_memalign.c | 9 | ||||
-rw-r--r-- | cpukit/libcsupport/src/setegid.c | 16 | ||||
-rw-r--r-- | cpukit/libcsupport/src/sup_fs_deviceerrno.c | 13 | ||||
-rw-r--r-- | cpukit/libcsupport/src/sup_fs_mount_iterate.c | 7 | ||||
-rw-r--r-- | cpukit/libcsupport/src/utsname.c | 16 | ||||
-rw-r--r-- | cpukit/libcsupport/src/write_r.c | 9 |
20 files changed, 174 insertions, 33 deletions
diff --git a/cpukit/libcsupport/src/_realloc_r.c b/cpukit/libcsupport/src/_realloc_r.c index 663812ea12..1dcc44178f 100644 --- a/cpukit/libcsupport/src/_realloc_r.c +++ b/cpukit/libcsupport/src/_realloc_r.c @@ -1,6 +1,11 @@ -/* - * _realloc_r Implementation +/** + * @file * + * @brief _realloc_r Implementation + * @ingroup libcsupport + */ + +/* * COPYRIGHT (c) 1989-2007. * On-Line Applications Research Corporation (OAR). * diff --git a/cpukit/libcsupport/src/access.c b/cpukit/libcsupport/src/access.c index 3319774e36..5013be53b3 100644 --- a/cpukit/libcsupport/src/access.c +++ b/cpukit/libcsupport/src/access.c @@ -1,6 +1,11 @@ -/* - * access() - POSIX 1003.1b 5.6.3 - File Accessibility +/** + * @file * + * @brief access() - POSIX 1003.1b 5.6.3 - File Accessibility + * @ingroup libcsupport + */ + +/* * COPYRIGHT (c) 1989-1999. * On-Line Applications Research Corporation (OAR). * diff --git a/cpukit/libcsupport/src/assoclocalbyname.c b/cpukit/libcsupport/src/assoclocalbyname.c index ed2d4cdce2..082ee6d812 100644 --- a/cpukit/libcsupport/src/assoclocalbyname.c +++ b/cpukit/libcsupport/src/assoclocalbyname.c @@ -1,6 +1,17 @@ +/** + * @file + * + * @brief RTEMS Associate Local by Name + * @ingroup Associativity Routines + */ + /* - * assoc.c - * rtems assoc routines + * COPYRIGHT (c) 1989-2008. + * On-Line Applications Research Corporation (OAR). + * + * 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. */ #if HAVE_CONFIG_H diff --git a/cpukit/libcsupport/src/assocremotebylocalbitfield.c b/cpukit/libcsupport/src/assocremotebylocalbitfield.c index 42c5d14963..bc2e98306d 100644 --- a/cpukit/libcsupport/src/assocremotebylocalbitfield.c +++ b/cpukit/libcsupport/src/assocremotebylocalbitfield.c @@ -1,6 +1,17 @@ +/** + * @file + * + * @brief RTEMS Assoc Routines + * @ingroup Associativity Routines + */ + /* - * assoc.c - * rtems assoc routines + * COPYRIGHT (c) 1989-2008. + * On-Line Applications Research Corporation (OAR). + * + * 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. */ #if HAVE_CONFIG_H diff --git a/cpukit/libcsupport/src/chdir.c b/cpukit/libcsupport/src/chdir.c index 88e9fcae68..9c49b9ee5e 100644 --- a/cpukit/libcsupport/src/chdir.c +++ b/cpukit/libcsupport/src/chdir.c @@ -1,6 +1,11 @@ -/* - * chdir() - POSIX 1003.1b - 5.2.1 - Change Current Working Directory +/** + * @file * + * @brief POSIX 1003.1b - 5.2.1 - Change Current Working Directory + * @ingroup libio Internal Interface + */ + +/* * COPYRIGHT (c) 1989-2010. * On-Line Applications Research Corporation (OAR). * diff --git a/cpukit/libcsupport/src/chroot.c b/cpukit/libcsupport/src/chroot.c index 9e63704f95..36f0eaa536 100644 --- a/cpukit/libcsupport/src/chroot.c +++ b/cpukit/libcsupport/src/chroot.c @@ -1,5 +1,11 @@ +/** + * @file + * + * @brief Change Root Directory + * @ingroup libcsupport + */ + /* - * chroot() - Change Root Directory * Author: fernando.ruiz@ctv.es * * COPYRIGHT (c) 1989-2008. diff --git a/cpukit/libcsupport/src/close.c b/cpukit/libcsupport/src/close.c index 2e6279dfd3..9b86d04d05 100644 --- a/cpukit/libcsupport/src/close.c +++ b/cpukit/libcsupport/src/close.c @@ -1,6 +1,11 @@ -/* - * close() - POSIX 1003.1b 6.3.1 - Close a File +/** + * @file * + * @brief POSIX 1003.1b 6.3.1 - Close a File + * @ingroup libcsupport + */ + +/* * COPYRIGHT (c) 1989-1999. * On-Line Applications Research Corporation (OAR). * diff --git a/cpukit/libcsupport/src/dup.c b/cpukit/libcsupport/src/dup.c index 324659f544..ddfc425b13 100644 --- a/cpukit/libcsupport/src/dup.c +++ b/cpukit/libcsupport/src/dup.c @@ -1,6 +1,11 @@ -/* - * dup() - POSIX 1003.1b 6.2.1 Duplicate an Open File Descriptor +/** + * @file * + * @brief POSIX 1003.1b 6.2.1 Duplicate an Open File Descriptor + * @ingroup libcsupport + */ + +/* * COPYRIGHT (c) 1989-1999. * On-Line Applications Research Corporation (OAR). * diff --git a/cpukit/libcsupport/src/fcntl.c b/cpukit/libcsupport/src/fcntl.c index ca04a0c20f..53feb669b1 100644 --- a/cpukit/libcsupport/src/fcntl.c +++ b/cpukit/libcsupport/src/fcntl.c @@ -1,6 +1,11 @@ -/* - * fcntl() - POSIX 1003.1b 6.5.2 - File Control +/** + * @file * + * @brief POSIX 1003.1b 6.5.2 - File Control + * @ingroup libcsupport + */ + +/* * COPYRIGHT (c) 1989-1999. * On-Line Applications Research Corporation (OAR). * diff --git a/cpukit/libcsupport/src/fdatasync.c b/cpukit/libcsupport/src/fdatasync.c index 3fd84df80e..91ec9da7b0 100644 --- a/cpukit/libcsupport/src/fdatasync.c +++ b/cpukit/libcsupport/src/fdatasync.c @@ -1,6 +1,11 @@ -/* - * fdatasync() - POSIX 1003.1b 6.6.2 - Synchronize the Data of a File +/** + * @file * + * @brief POSIX 1003.1b 6.6.2 - Synchronize the Data of a File + * @ingroup libcsupport + */ + +/* * COPYRIGHT (c) 1989-2011. * On-Line Applications Research Corporation (OAR). * diff --git a/cpukit/libcsupport/src/free.c b/cpukit/libcsupport/src/free.c index 1e29d74e80..4e31555a5e 100644 --- a/cpukit/libcsupport/src/free.c +++ b/cpukit/libcsupport/src/free.c @@ -1,6 +1,11 @@ -/* - * calloc() +/** + * @file * + * @brief calloc() + * @ingroup libcsupport + */ + +/* * COPYRIGHT (c) 1989-2007. * On-Line Applications Research Corporation (OAR). * diff --git a/cpukit/libcsupport/src/getcwd.c b/cpukit/libcsupport/src/getcwd.c index 337add2702..6e05c5dd22 100644 --- a/cpukit/libcsupport/src/getcwd.c +++ b/cpukit/libcsupport/src/getcwd.c @@ -1,3 +1,10 @@ +/** + * @file + * + * @brief Get Current Working Directory + * @ingroup libcsupport + */ + /* * Copyright (c) 1989, 1991 The Regents of the University of California. * All rights reserved. diff --git a/cpukit/libcsupport/src/ioctl.c b/cpukit/libcsupport/src/ioctl.c index 4a6a2ef66f..b583722d59 100644 --- a/cpukit/libcsupport/src/ioctl.c +++ b/cpukit/libcsupport/src/ioctl.c @@ -1,6 +1,11 @@ -/* - * ioctl() system call +/** + * @file * + * @brief ioctl() system call + * @ingroup libcsupport + */ + +/* * This routine is not defined in the POSIX 1003.1b standard but is * commonly supported on most UNIX and POSIX systems. * diff --git a/cpukit/libcsupport/src/kill_noposix.c b/cpukit/libcsupport/src/kill_noposix.c index 62270e3499..9d1e1acf82 100644 --- a/cpukit/libcsupport/src/kill_noposix.c +++ b/cpukit/libcsupport/src/kill_noposix.c @@ -1,4 +1,9 @@ -/* +/** + * @file + * + * @brief Kill No POSIX + * @ingroup libcsupport + * * Marginal implementations of some POSIX API routines * to be used when POSIX is disabled. * @@ -6,7 +11,9 @@ * + _kill_r * + __kill * + sleep - * + */ + +/* * 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. diff --git a/cpukit/libcsupport/src/posix_memalign.c b/cpukit/libcsupport/src/posix_memalign.c index d67c0caf57..961cff05d7 100644 --- a/cpukit/libcsupport/src/posix_memalign.c +++ b/cpukit/libcsupport/src/posix_memalign.c @@ -1,6 +1,11 @@ -/* - * posix_memalign() +/** + * @file * + * @brief Update call statistics + * @ingroup libcsupport + */ + +/* * COPYRIGHT (c) 1989-2008. * On-Line Applications Research Corporation (OAR). * diff --git a/cpukit/libcsupport/src/setegid.c b/cpukit/libcsupport/src/setegid.c index d2084595b9..d19ced41f9 100644 --- a/cpukit/libcsupport/src/setegid.c +++ b/cpukit/libcsupport/src/setegid.c @@ -1,3 +1,19 @@ +/** + * @file + * + * @brief Get Real User, Effective User, Ral Group, and Effective Group IDs + * @ingroup libcsupport + */ + +/* + * COPYRIGHT (c) 1989-2007. + * On-Line Applications Research Corporation (OAR). + * + * 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. + */ + #if HAVE_CONFIG_H #include "config.h" #endif diff --git a/cpukit/libcsupport/src/sup_fs_deviceerrno.c b/cpukit/libcsupport/src/sup_fs_deviceerrno.c index 4316496561..b03b32329a 100644 --- a/cpukit/libcsupport/src/sup_fs_deviceerrno.c +++ b/cpukit/libcsupport/src/sup_fs_deviceerrno.c @@ -1,9 +1,14 @@ -/* - * IMFS Device Node Handlers +/** + * @file * - * This file contains the set of handlers used to map operations on - * IMFS device nodes onto calls to the RTEMS Classic API IO Manager. + * @brief IMFS Device Node Handlers + * @ingroup Device IO Handler * + * This file contains the set of handlers used to map operations on + * IMFS device nodes onto calls to the RTEMS Classic API IO Manager. + */ + +/* * COPYRIGHT (c) 1989-2008. * On-Line Applications Research Corporation (OAR). * diff --git a/cpukit/libcsupport/src/sup_fs_mount_iterate.c b/cpukit/libcsupport/src/sup_fs_mount_iterate.c index 88cfca828c..67f143c5a9 100644 --- a/cpukit/libcsupport/src/sup_fs_mount_iterate.c +++ b/cpukit/libcsupport/src/sup_fs_mount_iterate.c @@ -1,3 +1,10 @@ +/** + * @file + * + * @brief Mount table entry visitor. + * @ingroup Termios Termios + */ + /* * Copyright (c) 2012 embedded brains GmbH. All rights reserved. * diff --git a/cpukit/libcsupport/src/utsname.c b/cpukit/libcsupport/src/utsname.c index cc9648510d..5af5e1a97d 100644 --- a/cpukit/libcsupport/src/utsname.c +++ b/cpukit/libcsupport/src/utsname.c @@ -1,3 +1,19 @@ +/** + * @file + * + * @brief Get System Name + * @ingroup utsname Service + */ + +/* + * COPYRIGHT (c) 1989-1999. + * On-Line Applications Research Corporation (OAR). + * + * 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. + */ + #if HAVE_CONFIG_H #include "config.h" #endif diff --git a/cpukit/libcsupport/src/write_r.c b/cpukit/libcsupport/src/write_r.c index 9f63b88222..c5e41b3711 100644 --- a/cpukit/libcsupport/src/write_r.c +++ b/cpukit/libcsupport/src/write_r.c @@ -1,6 +1,11 @@ -/* - * write_r() - POSIX 1003.1b 6.4.2 - Write to a File +/** + * @file * + * @brief POSIX 1003.1b 6.4.2 - Write to a File + * @ingroup libcsupport + */ + +/* * COPYRIGHT (c) 1989-2007. * On-Line Applications Research Corporation (OAR). * |