summaryrefslogtreecommitdiffstats
path: root/cpukit/libnetworking/rtems/mkrootfs.h
diff options
context:
space:
mode:
authorRalf Corsepius <ralf.corsepius@rtems.org>2010-06-18 10:03:40 +0000
committerRalf Corsepius <ralf.corsepius@rtems.org>2010-06-18 10:03:40 +0000
commit432c4f08dc890622001d2e5c505600230aa1cffa (patch)
tree962dc15ec869b42c28a2e96209a82bbbc32caaca /cpukit/libnetworking/rtems/mkrootfs.h
parent2010-06-18 Ralf Corsépius <ralf.corsepius@rtems.org> (diff)
downloadrtems-432c4f08dc890622001d2e5c505600230aa1cffa.tar.bz2
2010-06-18 Ralf Corsépius <ralf.corsepius@rtems.org>
* libnetworking/rtems/mkrootfs.h: doxygen cosmetics.
Diffstat (limited to 'cpukit/libnetworking/rtems/mkrootfs.h')
-rw-r--r--cpukit/libnetworking/rtems/mkrootfs.h25
1 files changed, 20 insertions, 5 deletions
diff --git a/cpukit/libnetworking/rtems/mkrootfs.h b/cpukit/libnetworking/rtems/mkrootfs.h
index 857b633264..8bf053bc52 100644
--- a/cpukit/libnetworking/rtems/mkrootfs.h
+++ b/cpukit/libnetworking/rtems/mkrootfs.h
@@ -30,9 +30,16 @@
extern "C" {
#endif
-/*
+/**
* Appends the lines to the a file. Create the file
* and builds the path if it does not exist.
+ *
+ * @param file
+ * @param omode
+ * @param line_cnt
+ * @param lines
+ *
+ * @return 0 on success, -1 on error
*/
int
@@ -41,8 +48,14 @@ rtems_rootfs_file_append (const char *file,
const int line_cnt,
const char **lines);
-/*
- * Helper for bulding an /etc/hosts file.
+/**
+ * @brief Helper for bulding an /etc/hosts file.
+ *
+ * @param cip
+ * @param cname
+ * @param dname
+ *
+ * @return 0 on success, -1 on error
*/
int
@@ -50,10 +63,12 @@ rtems_rootfs_append_host_rec (in_addr_t cip,
const char *cname,
const char *dname);
-/*
- * Create a few common directories, plus a :
+/**
+ * Create a few common directories, plus a:
* /etc/passwd, /etc/group, /etc/host.conf, and
* /etc/hosts file.
+ *
+ * @return 0 on success, -1 on error
*/
int