Reorder a bit status messages, but they are still cleared at the end of LyXFunc

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

diff --git a/src/support/FileName.h b/src/support/FileName.h
index 0a433d278fe811dba290fb0db45f44496f6b0490..3d64ad091f5e40d41b74895936e4aef2c9b61595 100644 (file)
--- a/src/support/FileName.h
+++ b/src/support/FileName.h
@@ -78,6 +78,8 @@ public:
 
        /// returns true if the file exists
        bool exists() const;
+       /// refreshes the file info
+       void refresh() const;
        /// \return true if this object points to a symbolic link.
        bool isSymLink() const;
        /// \return true if the file is empty.
@@ -204,11 +206,18 @@ private:
 };
 
 
-bool equivalent(FileName const &, FileName const &);
+/// \return true if lhs and rhs represent the same file. E.g.,
+/// they might be hardlinks of one another.
+bool equivalent(FileName const & lhs, FileName const & rhs);
+/// \return true if the absolute path names are the same.
 bool operator==(FileName const &, FileName const &);
+///
 bool operator!=(FileName const &, FileName const &);
+/// Lexically compares the absolute path names.
 bool operator<(FileName const &, FileName const &);
+/// Lexically compares the absolute path names.
 bool operator>(FileName const &, FileName const &);
+/// Writes the absolute path name to the stream.
 std::ostream & operator<<(std::ostream &, FileName const &);
 
 
@@ -222,7 +231,7 @@ class DocFileName : public FileName {
 public:
        DocFileName();
        /** \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?
+        *  \param save_abs_path how is the filename to be output?
         */
        DocFileName(std::string const & abs_filename, bool save_abs_path = true);
        DocFileName(FileName const & abs_filename, bool save_abs_path = true);
@@ -233,9 +242,9 @@ public:
         *  the absolute path using this.
         */
        virtual void set(std::string const & filename, std::string const & buffer_path);
-
+       ///
        void erase();
-
+       ///
        bool saveAbsPath() const { return save_abs_path_; }
        /// \param buffer_path if empty, uses `pwd`
        std::string relFilename(std::string const & buffer_path = empty_string()) const;
@@ -271,6 +280,8 @@ public:
        std::string unzippedFilename() const;
 
 private:
+       /// Records whether we should save (or export) the filename as a relative
+       /// or absolute path.
        bool save_abs_path_;
        /// Cache for isZipped() because zippedFile() is expensive
        mutable bool zipped_;
@@ -279,7 +290,10 @@ private:
 };
 
 
+/// \return true if these have the same absolute path name AND 
+/// if save_abs_path_ has the same value in both cases.
 bool operator==(DocFileName const &, DocFileName const &);
+///
 bool operator!=(DocFileName const &, DocFileName const &);
 
 } // namespace support