diff options
author | Alex Ivanov <alexivanov97@gmail.com> | 2012-12-13 12:13:19 -0600 |
---|---|---|
committer | Jennifer Averett <jennifer.averett@oarcorp.com> | 2012-12-13 12:13:19 -0600 |
commit | 41b590f966d9ff6a760bd492a649fe33f1f4606a (patch) | |
tree | d1401b578183bd5297a2525a99f5a0840d1bd48c /cpukit/libcsupport/src | |
parent | da02535ac50b7d3a67820441f603326ac23af0b8 (diff) |
libcsupport: Doxygen enhancement task #9
Diffstat (limited to 'cpukit/libcsupport/src')
-rw-r--r-- | cpukit/libcsupport/src/clonenode.c | 7 | ||||
-rw-r--r-- | cpukit/libcsupport/src/fpathconf.c | 12 | ||||
-rw-r--r-- | cpukit/libcsupport/src/fsync.c | 12 | ||||
-rw-r--r-- | cpukit/libcsupport/src/gxx_wrappers.c | 9 | ||||
-rw-r--r-- | cpukit/libcsupport/src/issetugid.c | 12 | ||||
-rw-r--r-- | cpukit/libcsupport/src/lstat.c | 13 | ||||
-rw-r--r-- | cpukit/libcsupport/src/mount.c | 18 | ||||
-rw-r--r-- | cpukit/libcsupport/src/pathconf.c | 12 | ||||
-rw-r--r-- | cpukit/libcsupport/src/printk.c | 13 | ||||
-rw-r--r-- | cpukit/libcsupport/src/privateenv.c | 11 | ||||
-rw-r--r-- | cpukit/libcsupport/src/rmdir.c | 12 | ||||
-rw-r--r-- | cpukit/libcsupport/src/rtems_memalign.c | 9 | ||||
-rw-r--r-- | cpukit/libcsupport/src/seteuid.c | 7 |
13 files changed, 112 insertions, 35 deletions
diff --git a/cpukit/libcsupport/src/clonenode.c b/cpukit/libcsupport/src/clonenode.c index 0ac7c9ef40..3004def15b 100644 --- a/cpukit/libcsupport/src/clonenode.c +++ b/cpukit/libcsupport/src/clonenode.c @@ -1,3 +1,10 @@ +/** + * @file + * + * @brief Clones a Node + * @ingroup LibIOInternal + */ + /* * Copyright (c) 2012 embedded brains GmbH. All rights reserved. * diff --git a/cpukit/libcsupport/src/fpathconf.c b/cpukit/libcsupport/src/fpathconf.c index a48c5d35fc..104a3512e8 100644 --- a/cpukit/libcsupport/src/fpathconf.c +++ b/cpukit/libcsupport/src/fpathconf.c @@ -1,6 +1,11 @@ -/* - * fpathconf() - POSIX 1003.1b - 5.7.1 - Configurable Pathname Varables +/** + * @file * + * @brief Configurable Pathname Varables + * @ingroup libcsupport + */ + +/* * COPYRIGHT (c) 1989-2011. * On-Line Applications Research Corporation (OAR). * @@ -19,6 +24,9 @@ #include <unistd.h> #include <errno.h> +/** + * POSIX 1003.1b - 5.7.1 - Configurable Pathname Varables + */ long fpathconf( int fd, int name diff --git a/cpukit/libcsupport/src/fsync.c b/cpukit/libcsupport/src/fsync.c index 2bdf982090..885d32718a 100644 --- a/cpukit/libcsupport/src/fsync.c +++ b/cpukit/libcsupport/src/fsync.c @@ -1,6 +1,11 @@ -/* - * fsync() - POSIX 1003.1b 6.6.1 - Synchronize the State of a File +/** + * @file * + * @brief Synchronize the State of a File + * @ingroup libcsupport + */ + +/* * COPYRIGHT (c) 1989-2011. * On-Line Applications Research Corporation (OAR). * @@ -18,6 +23,9 @@ #include <rtems/libio_.h> #include <rtems/seterr.h> +/** + * POSIX 1003.1b 6.6.1 - Synchronize the State of a File + */ int fsync( int fd ) diff --git a/cpukit/libcsupport/src/gxx_wrappers.c b/cpukit/libcsupport/src/gxx_wrappers.c index 2979da4b38..cd1ecc6339 100644 --- a/cpukit/libcsupport/src/gxx_wrappers.c +++ b/cpukit/libcsupport/src/gxx_wrappers.c @@ -1,6 +1,11 @@ -/* - * RTEMS threads compatibility routines for libgcc2. +/** + * @file * + * @brief RTEMS Threads Compatibility Routines for Libgcc2 + * @ingroup GxxWrappersSupport + */ + +/* * by: Rosimildo da Silva (rdasilva@connecttel.com) * * Used ideas from: diff --git a/cpukit/libcsupport/src/issetugid.c b/cpukit/libcsupport/src/issetugid.c index 375fea8d9b..0cb870ea00 100644 --- a/cpukit/libcsupport/src/issetugid.c +++ b/cpukit/libcsupport/src/issetugid.c @@ -1,12 +1,20 @@ -/* - * Dummy version of BSD routine +/** + * @file + * + * @brief Dummy Version of BSD Routine + * @ingroup libcsupport */ + #if HAVE_CONFIG_H #include "config.h" #endif #if defined(RTEMS_NEWLIB) && !defined(HAVE_ISSETUGID) + +/** + * Dummy version of BSD routine + */ int issetugid (void) { return 0; diff --git a/cpukit/libcsupport/src/lstat.c b/cpukit/libcsupport/src/lstat.c index 3cf93bee27..abdc0465cd 100644 --- a/cpukit/libcsupport/src/lstat.c +++ b/cpukit/libcsupport/src/lstat.c @@ -1,6 +1,11 @@ -/* - * lstat() - BSD 4.3 and SVR4 - Get File Status +/** + * @file * + * @brief Get File Status + * @ingroup libcsupport + */ + +/* * COPYRIGHT (c) 1989-1999. * On-Line Applications Research Corporation (OAR). * @@ -18,3 +23,7 @@ #define _STAT_FOLLOW_LINKS RTEMS_FS_FOLLOW_HARD_LINK #include "stat.c" + +/** + * BSD 4.3 and SVR4 - Get File Status + */
\ No newline at end of file diff --git a/cpukit/libcsupport/src/mount.c b/cpukit/libcsupport/src/mount.c index 8eb4796fb2..92033e1904 100644 --- a/cpukit/libcsupport/src/mount.c +++ b/cpukit/libcsupport/src/mount.c @@ -1,12 +1,11 @@ -/* - * mount() - * - * XXX - * - * XXX make sure no required ops are NULL - * XXX make sure no optional ops you are using are NULL - * XXX unmount should be required. +/** + * @file * + * @brief Mounts a File System + * @ingroup FileSystemTypesAndMount + */ + +/* * COPYRIGHT (c) 1989-2010. * On-Line Applications Research Corporation (OAR). * @@ -28,9 +27,6 @@ RTEMS_CHAIN_DEFINE_EMPTY(rtems_filesystem_mount_table); -/* - * Default pathconfs. - */ const rtems_filesystem_limits_and_options_t rtems_filesystem_default_pathconf = { 5, /* link_max: count */ 128, /* max_canon: max formatted input line size */ diff --git a/cpukit/libcsupport/src/pathconf.c b/cpukit/libcsupport/src/pathconf.c index c337d44955..690817c3e8 100644 --- a/cpukit/libcsupport/src/pathconf.c +++ b/cpukit/libcsupport/src/pathconf.c @@ -1,6 +1,11 @@ -/* - * pathconf() - POSIX 1003.1b - 5.7.1 - Configurable Pathname Varables +/** + * @file * + * @brief Configurable Pathname Varables + * @ingroup libcsupport + */ + +/* * COPYRIGHT (c) 1989-1999. * On-Line Applications Research Corporation (OAR). * @@ -19,6 +24,9 @@ #include <sys/stat.h> #include <fcntl.h> +/** + * POSIX 1003.1b - 5.7.1 - Configurable Pathname Varables + */ long pathconf( const char *path, int name diff --git a/cpukit/libcsupport/src/printk.c b/cpukit/libcsupport/src/printk.c index 0a2989226c..badbd0d591 100644 --- a/cpukit/libcsupport/src/printk.c +++ b/cpukit/libcsupport/src/printk.c @@ -1,3 +1,10 @@ +/** + * @file + * + * @brief Kernel Printf Function + * @ingroup libcsupport + */ + /* * (C) Copyright 1997 - * - NavIST Group - Real-Time Distributed Systems and Industrial Automation @@ -22,10 +29,8 @@ #include <stdio.h> #include <rtems/bspIo.h> -/* - * printk - * - * Kernel printf function requiring minimal infrastructure. +/** + * Kernel printf function requiring minimal infrastructure. */ void printk(const char *fmt, ...) { diff --git a/cpukit/libcsupport/src/privateenv.c b/cpukit/libcsupport/src/privateenv.c index 04622fd432..f5fd67db95 100644 --- a/cpukit/libcsupport/src/privateenv.c +++ b/cpukit/libcsupport/src/privateenv.c @@ -1,12 +1,11 @@ /** - * @file + * @file * - * @ingroup LibIOEnv + * @brief Instantiate a Private User Environment + * @ingroup LibIOEnv */ /* - * Instantiate a private user environment for the calling thread. - * * Submitted by: fernando.ruiz@ctv.es (correo@fernando-ruiz.com) * * COPYRIGHT (c) 1989-2010. @@ -28,6 +27,10 @@ #include <rtems/libio_.h> #include <rtems/score/thread.h> +/** + * Instantiate a private user environment for the calling thread. + */ + static void free_user_env(void *arg) { rtems_user_env_t *env = arg; diff --git a/cpukit/libcsupport/src/rmdir.c b/cpukit/libcsupport/src/rmdir.c index 5e4c9f15be..4802aa364c 100644 --- a/cpukit/libcsupport/src/rmdir.c +++ b/cpukit/libcsupport/src/rmdir.c @@ -1,6 +1,11 @@ -/* - * rmdir() - POSIX 1003.1b - 5.2.2 - Remove a Directory +/** + * @file * + * @brief Remove a Directory + * @ingroup libcsupport + */ + +/* * COPYRIGHT (c) 1989-1999. * On-Line Applications Research Corporation (OAR). * @@ -17,6 +22,9 @@ #include <rtems/libio_.h> +/** + * POSIX 1003.1b - 5.2.2 - Remove a Directory + */ int rmdir( const char *path ) { int rv = 0; diff --git a/cpukit/libcsupport/src/rtems_memalign.c b/cpukit/libcsupport/src/rtems_memalign.c index b7760372f4..64bb489dae 100644 --- a/cpukit/libcsupport/src/rtems_memalign.c +++ b/cpukit/libcsupport/src/rtems_memalign.c @@ -1,6 +1,11 @@ -/* - * rtems_memalign() - Raw aligned allocate from Protected Heap +/** + * @file * + * @brief RTEMS Variation on Aligned Memory Allocation + * @ingroup MallocSupport + */ + +/* * COPYRIGHT (c) 1989-2008. * On-Line Applications Research Corporation (OAR). * diff --git a/cpukit/libcsupport/src/seteuid.c b/cpukit/libcsupport/src/seteuid.c index 406cc9ff24..6495decdc3 100644 --- a/cpukit/libcsupport/src/seteuid.c +++ b/cpukit/libcsupport/src/seteuid.c @@ -1,3 +1,10 @@ +/** + * @file + * + * @brief Set Effective User Id + * @ingroup libcsupport + */ + /* * COPYRIGHT (c) 1989-2010. * On-Line Applications Research Corporation (OAR). |