src/core/model/system-path.cc
changeset 11046 e62bccfbe56e
parent 10968 2d29fee2b7b8
child 11097 caafe12b0378
--- a/src/core/model/system-path.cc	Mon Nov 03 12:33:13 2014 -0800
+++ b/src/core/model/system-path.cc	Mon Nov 03 12:40:24 2014 -0800
@@ -61,6 +61,16 @@
 
 namespace SystemPath {
 
+/**
+ * \ingroup systempath
+ * \brief Get the directory path for a file.
+ *
+ * This is an internal function (by virtue of not being
+ * declared in a \c .h file); the public API is FindSelfDirectory().
+ * 
+ * \param path The full path to a file.
+ * \returns The full path to the containing directory.
+ */
 std::string Dirname (std::string path)
 {
   NS_LOG_FUNCTION (path);