summaryrefslogtreecommitdiffstats
path: root/cpukit/libmisc/untar
diff options
context:
space:
mode:
authorMathew Kallada <matkallada@gmail.com>2012-12-19 09:51:38 -0500
committerGedare Bloom <gedare@rtems.org>2012-12-19 09:51:38 -0500
commit148e3de629fff11c7598ff178cb125ae3f8b5d12 (patch)
treeac348c795f82037f1746e1ab237fd280ff3f2c1d /cpukit/libmisc/untar
parentposix: Doxygen Enhancement Task #3 (diff)
downloadrtems-148e3de629fff11c7598ff178cb125ae3f8b5d12.tar.bz2
libmisc: Doxygen Enhancement Task #2
http://www.google-melange.com/gci/task/view/google/gci2012/7959228
Diffstat (limited to 'cpukit/libmisc/untar')
-rw-r--r--cpukit/libmisc/untar/untar.c13
-rw-r--r--cpukit/libmisc/untar/untar.h8
2 files changed, 18 insertions, 3 deletions
diff --git a/cpukit/libmisc/untar/untar.c b/cpukit/libmisc/untar/untar.c
index 337782b5c1..5cebc2d9ed 100644
--- a/cpukit/libmisc/untar/untar.c
+++ b/cpukit/libmisc/untar/untar.c
@@ -1,8 +1,17 @@
-/* FIXME:
+/**
+ * @file
+ *
+ * @brief Untar an Image
+ * @ingroup libmisc_untar_img Untar Image
+ *
+ * FIXME:
* 1. Symbolic links are not created.
* 2. Untar_FromMemory uses FILE *fp.
* 3. How to determine end of archive?
*
+ */
+
+/*
* Written by: Jake Janovetz <janovetz@tempest.ece.uiuc.edu>
*
* The license and distribution terms for this file may be
@@ -274,7 +283,7 @@ Untar_FromFile(
if (bufr == NULL) {
return(UNTAR_FAIL);
}
-
+
while (1)
{
/* Read the header */
diff --git a/cpukit/libmisc/untar/untar.h b/cpukit/libmisc/untar/untar.h
index dca8216644..81cbd0e8ba 100644
--- a/cpukit/libmisc/untar/untar.h
+++ b/cpukit/libmisc/untar/untar.h
@@ -18,6 +18,12 @@
#include <stddef.h>
#include <tar.h>
+/**
+ * @defgroup libmisc_untar_img Untar Image
+ *
+ * @ingroup libmisc
+ */
+/**@{*/
#ifdef __cplusplus
extern "C" {
#endif
@@ -49,5 +55,5 @@ _rtems_tar_header_checksum(const char *bufr);
#ifdef __cplusplus
}
#endif
-
+/**@}*/
#endif /* _RTEMS_UNTAR_H */