summaryrefslogtreecommitdiffstats
path: root/cpukit/libcsupport/src/truncate.c
diff options
context:
space:
mode:
authorAlex Ivanov <alexivanov97@gmail.com>2012-12-09 17:55:17 -0500
committerGedare Bloom <gedare@rtems.org>2012-12-09 17:55:17 -0500
commitbcd0ea64091d4c360b48cfabbfb94b4f562a9eaa (patch)
treec19e154cfb32d246159933209e1c404be752e8e6 /cpukit/libcsupport/src/truncate.c
parentlibcsupport: Fix documentation (diff)
downloadrtems-bcd0ea64091d4c360b48cfabbfb94b4f562a9eaa.tar.bz2
libcsupport: Doxygen enhancement task #2
http://www.google-melange.com/gci/task/view/google/gci2012/8017203
Diffstat (limited to 'cpukit/libcsupport/src/truncate.c')
-rw-r--r--cpukit/libcsupport/src/truncate.c18
1 files changed, 12 insertions, 6 deletions
diff --git a/cpukit/libcsupport/src/truncate.c b/cpukit/libcsupport/src/truncate.c
index 5d58128dd3..654d99e4d9 100644
--- a/cpukit/libcsupport/src/truncate.c
+++ b/cpukit/libcsupport/src/truncate.c
@@ -1,10 +1,11 @@
-/*
- * truncate() - Truncate a File to the Specified Length
- *
- * This routine is not defined in the POSIX 1003.1b standard but is
- * commonly supported on most UNIX and POSIX systems. It is provided
- * for compatibility.
+/**
+ * @file
*
+ * @brief Truncate a File to the Specified Length
+ * @ingroup libcsupport
+ */
+
+/*
* COPYRIGHT (c) 1989-1999.
* On-Line Applications Research Corporation (OAR).
*
@@ -21,6 +22,11 @@
#include <errno.h>
#include <fcntl.h>
+/**
+ * This routine is not defined in the POSIX 1003.1b standard but is
+ * commonly supported on most UNIX and POSIX systems. It is provided
+ * for compatibility.
+ */
int truncate(
const char *path,
off_t length