From 4dea2f27d01edfa6bdaea8f31004c1fe45251173 Mon Sep 17 00:00:00 2001 From: rgheck Date: Wed, 8 Jul 2009 19:55:03 +0000 Subject: [PATCH] More comments. git-svn-id: svn://svn.lyx.org/lyx/lyx-devel/trunk@30415 a592a061-630c-0410-9148-cb99ea01b6c8 --- src/support/FileName.h | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/src/support/FileName.h b/src/support/FileName.h index a6ceec003a..51c149ff9e 100644 --- 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 -- 2.11.4.GIT