make gettting the file format from file contents work in the correct way ;-)

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

diff --git a/src/support/filetools.h b/src/support/filetools.h
index f7b80c6c18fcc79b13cfa4de1e5c22368de8dbd2..6b4c4b1edfaa136151dfe7edf621f46f87d78a0b 100644 (file)
--- a/src/support/filetools.h
+++ b/src/support/filetools.h
@@ -140,7 +140,10 @@ ChangeExtension(std::string const & oldname, std::string const & extension);
 /// Return the extension of the file (not including the .)
 std::string const GetExtension(std::string const & name);
 
-/// Guess the file format name (as in Format::name()) from contents
+/** Guess the file format name (as in Format::name()) from contents.
+ Normally you don't want to use this directly, but rather
+ Formats::getFormatFromFile().
+ */
 std::string const getFormatFromContents(std::string const & name);
 
 /// check for zipped file