--- a/src/core/model/system-path.h Sun Dec 07 22:08:04 2014 -0800
+++ b/src/core/model/system-path.h Tue Dec 09 13:17:49 2014 -0800
@@ -23,10 +23,16 @@
#include <string>
#include <list>
+/**
+ * \file
+ * \ingroup systempath
+ * System-independent file and directory function declarations.
+ */
+
namespace ns3 {
/**
- * \ingroup testing
+ * \ingroup system
* \defgroup systempath Host Filesystem
* \brief Encapsulate OS-specific functions to manipulate file
* and directory paths.
@@ -36,11 +42,6 @@
*/
/**
- * \addtogroup core
- * \see systempath
- */
-
-/**
* \ingroup systempath
* \brief Namespace for various file and directory path functions.
*/
@@ -48,12 +49,16 @@
/**
* \ingroup systempath
+ * Get the file system path to the current executable.
+ *
* \return the directory in which the currently-executing binary is located
*/
std::string FindSelfDirectory (void);
/**
* \ingroup systempath
+ * Join two file system path elements.
+ *
* \param left a path element
* \param right a path element
* \return a concatenation of the two input paths
@@ -62,6 +67,11 @@
/**
* \ingroup systempath
+ * Split a file system path into directories according to
+ * the local path separator.
+ *
+ * This is the inverse of Join.
+ *
* \param path a path
* \return a list of path elements that can be joined together again with
* the Join function.
@@ -70,6 +80,11 @@
std::list<std::string> Split (std::string path);
/**
+ * Join a list of file system path directories into a single
+ * file system path.
+ *
+ * This is the inverse of Split.
+ *
* \ingroup systempath
* \param begin iterator to first element to join
* \param end iterator to last element to join
@@ -80,6 +95,8 @@
/**
* \ingroup systempath
+ * Get the list of files located in a file system directory.
+ *
* \param path a path which identifies a directory
* \return a list of the filenames which are located in the input directory
*/
@@ -87,19 +104,21 @@
/**
* \ingroup systempath
- * \return a path which identifies a temporary directory.
+ * Get the name of a temporary directory.
*
- * The returned path identifies a directory which does not exist yet
+ * The returned path identifies a directory which does not exist yet.
* Call ns3::SystemPath::MakeDirectories to create it. Yes, there is a
* well-known security race in this API but we don't care in ns-3.
+ *
+ * \return a path which identifies a temporary directory.
*/
std::string MakeTemporaryDirectoryName (void);
/**
* \ingroup systempath
- * \param path a path to a directory
+ * Create all the directories leading to path.
*
- * Create all the directories leading to path.
+ * \param path a path to a directory
*/
void MakeDirectories (std::string path);