Modify PBD::sys::basename to match boost::filesystem behaviour and document it.

This makes this function equivalent to PBD::basename_nosuffix, sys::basename
takes a path as an argument rather than a string but that is ok as a path can
automatically constructed from a string.


git-svn-id: svn://localhost/ardour2/trunk@2404 d708f5d6-7413-0410-9779-e7cbd77b26cf

1 files changed, 8 insertions, 1 deletions

diff --git a/libs/pbd/pbd/filesystem.h b/libs/pbd/pbd/filesystem.h
index a5b0ed5b28..b5f328acf4 100644
--- a/libs/pbd/pbd/filesystem.h
+++ b/libs/pbd/pbd/filesystem.h
@@ -162,7 +162,14 @@ bool remove(const path & p);
  */
 void copy_file(const path & from_path, const path & to_path);
 
-
+/**
+ * @return The substring of the filename component of the path, starting
+ * at the beginning of the filename up to but not including the last dot.
+ *
+ * boost::filesystem::path::basename differs from g_path_get_basename and
+ * ::basename and most other forms of basename in that it removes the
+ * extension from the filename if the filename has one.
+ */ 
 string basename (const path& p);
 
 } // namespace sys