Add and update some comments.

git-svn-id: svn://svn.lyx.org/lyx/lyx-devel/trunk@30405 a592a061-630c-0410-9148-cb99ea01b6c8

diff --git a/src/support/FileName.h b/src/support/FileName.h
index 0a433d278fe811dba290fb0db45f44496f6b0490..a6ceec003a5e58508cf4129ff466d64e97f335ef 100644 (file)
--- a/src/support/FileName.h
+++ b/src/support/FileName.h
@@ -222,7 +222,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 +233,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 +271,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_;