More comments.

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

diff --git a/src/support/FileName.h b/src/support/FileName.h
index a6ceec003a5e58508cf4129ff466d64e97f335ef..51c149ff9e5d708396096b30213fa89682c2730f 100644 (file)
--- a/src/support/FileName.h
+++ b/src/support/FileName.h
@@ -204,11 +204,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 &);
 
 
@@ -281,7 +288,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