]> git.lyx.org Git - lyx.git/blobdiff - src/support/filetools.h
If I ever see another licence blurb again, it'll be too soon...
[lyx.git] / src / support / filetools.h
index 509c4b04afc0d5957484aba0c39b38eb9c37233b..8203d3aaa7b549cfade443c4de2e680bf6abb262 100644 (file)
@@ -1,12 +1,12 @@
-// -*- C++-*-
+// -*- C++ -*-
 /**
  * \file filetools.h
  * This file is part of LyX, the document processor.
  * Licence details can be found in the file COPYING.
  *
- * \author Lars Gullik Bjønnes
+ * \author Lars Gullik Bjønnes
  *
- * Full author contact details are available in file CREDITS
+ * Full author contact details are available in file CREDITS.
  */
 
 #ifndef LYX_FILETOOL_H
@@ -18,6 +18,9 @@
 #include "os.h"
 
 
+namespace lyx {
+namespace support {
+
 /// remove directory and all contents, returns 0 on success
 int destroyDir(string const & tmpdir);
 
@@ -207,15 +210,20 @@ void removeAutosaveFile(string const & filename);
 /// read the BoundingBox entry from a ps/eps/pdf-file
 string const readBB_from_PSFile(string const & file);
 
-/** Copy \param file to directory \param path. The file name is manipulated
+/** Copy \c file to directory \c path. The file name is manipulated
     so that eg some/path/to/file becomes some_path_to_file.
+    \param path where to put the file
+    \param file the file that is copied
     \returns this file name if the file is copied successfully, else
     \returns an empty string.
  */
-string copyFileToDir(string const & path, string const & file);
+string const copyFileToDir(string const & path, string const & file);
 
 typedef std::pair<int, string> cmd_ret;
 
 cmd_ret const RunCommand(string const & cmd);
 
+} // namespace support
+} // namespace lyx
+
 #endif