* lyxfunctional.h: delete compare_memfun and helper classes

[lyx.git] / src / support / filename.h

diff --git a/src/support/filename.h b/src/support/filename.h
index 4085c51fef0341705a1dbf82ba407a15ab136799..06b164c2e4da187b9bb81c42a8233c8680a65394 100644 (file)
--- a/src/support/filename.h
+++ b/src/support/filename.h
@@ -22,7 +22,7 @@ namespace support {
 class FileName {
 public:
        FileName();
-       /** \param filename the file in question. Must have an absolute path.
+       /** \param abs_filename the file in question. Must have an absolute path.
         *  \param save_abs_path how is the file to be output to file?
         */
        FileName(std::string const & abs_filename, bool save_abs_path = true);
@@ -46,6 +46,10 @@ public:
        /** \return a mangled version of the absolute file name,
         *  suitable for use in the temp dir when, for example, converting
         *  an image file to another format.
+        *  It is guaranteed that
+        *  - two different filenames have different mangled names
+        *  - two FileName instances with the same filename have identical
+        *    mangled names
         */
        std::string const mangledFilename() const;