X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2Flastfiles.h;h=e053af70591fec723bb3157bf20fbbdcf7afced7;hb=005545f28100fd30afa22313d6e3b1b67aa9a857;hp=6e9bd81fab5d701a1d3810957ac25089c63774eb;hpb=797d87b4513088a66b17c7ac653b84e36ea80458;p=lyx.git

diff --git a/src/lastfiles.h b/src/lastfiles.h
index 6e9bd81fab..e053af7059 100644
--- a/src/lastfiles.h
+++ b/src/lastfiles.h
@@ -1,25 +1,22 @@
 // -*- C++ -*-
-/* This file is part of
- * ====================================================== 
- * 
- *           LyX, The Document Processor
- * 	 
- *           Copyright 1995 Matthias Ettrich
- *           Copyright 1995-2000 The LyX Team.
+/**
+ * \file lastfiles.h
+ * This file is part of LyX, the document processor.
+ * Licence details can be found in the file COPYING.
  *
- * ====================================================== */
+ * \author Lars Gullik Bjønnes
+ *
+ * Full author contact details are available in file CREDITS.
+ */
 
 #ifndef LASTFILES_H
 #define LASTFILES_H
 
-#ifdef __GNUG__
-#pragma interface
-#endif
+#include <boost/utility.hpp>
 
 #include <deque>
+#include <string>
 
-#include "LString.h"
-#include "support/utility.hpp"
 
 /** The latest documents loaded.
     This class takes care of the last .lyx files used by the LyX user. It
@@ -27,40 +24,45 @@
     kept are user defined, but defaults to four.
     @author Lars Gullik Bjønnes
 */
-class LastFiles : public noncopyable {
+class LastFiles : boost::noncopyable {
 public:
 	///
-	typedef std::deque<string> Files;
+	typedef std::deque<std::string> Files;
 
 	///
 	typedef Files::const_iterator const_iterator;
-	
+
 	/** Read the lastfiles file.
-	   @param file The file to read the lastfiles form.
-	   @param dostat Whether to check for file existance.
-	   @param num number of files to remember.
+	    @param file The file to read the lastfiles form.
+	    @param dostat Whether to check for file existance.
+	    @param num number of files to remember.
 	*/
 	explicit
-	LastFiles(string const & file,
+	LastFiles(std::string const & file,
 		  bool dostat = true, unsigned int num = 4);
-	
-	/**
-	   This funtion inserts #file# into the last files list. If the file
-	   already exist it is moved to the top of the list, else exist it
-	   is placed on the top of the list. If the list is full the last
-	   file in the list is popped from the end.
+
+	/** Insert #file# into the list.
+	    This funtion inserts #file# into the last files list. If the file
+	    already exist it is moved to the top of the list, else exist it
+	    is placed on the top of the list. If the list is full the last
+	    file in the list is popped from the end.
+	    @param file the file to insert in the list.
 	*/
-	void newFile(string const & file);
-	/**  Writes the lastfiles table to disk. One file on each line, this
-	     way we can at least have some special chars (e.g. space), but
-	     newline in filenames are thus not allowed.
+	void newFile(std::string const & file);
+	/** Writes the lastfiles table to disk.
+	    Writes one file on each line, this way we can at least have
+	    some special chars (e.g. space), but newline in filenames
+	    are thus not allowed.
+	    @param file the file we write the lastfiles list to.
 	*/
-	void writeFile(string const &) const;
-	///
-	string const operator[](unsigned int) const;
-	///
+	void writeFile(std::string const & file) const;
+	/** Return file #n# in the lastfiles list.
+	    @param n number in the list to get
+	*/
+	std::string const operator[](unsigned int n) const;
+	/// Iterator to the beginning of the list.
 	Files::const_iterator begin() const { return files.begin(); }
-	///
+	/// Iterator to the end of the list.
 	Files::const_iterator end() const { return files.end(); }
 private:
 	/** Local constants.
@@ -79,22 +81,25 @@ private:
 		*/
 		ABSOLUTEMAXLASTFILES = 20
 	};
-	
+
 	/// a list of lastfiles
 	Files files;
 	/// number of files in the lastfiles list.
 	unsigned int num_files;
 	/// check for file existance or not.
 	bool dostat;
-	
+
 	/** Read the lastfiles file.
-	    Reads the .lyx_lastfiles at the beginning of the LyX session.
-	    This will read the lastfiles file (usually .lyx_lastfiles). It
+	    Reads the #.lyx_lastfiles# at the beginning of the LyX session.
+	    This will read the lastfiles file (usually #.lyx_lastfiles#). It
 	    will normally discard files that don't exist anymore, unless
-	    LastFiles has been initialized with dostat = false. 
+	    LastFiles has been initialized with #dostat = false#.
+	    @param file the file containing the lastfiles.
+	*/
+	void readFile(std::string const & file);
+	/** Used by the constructor to set the number of stored last files.
+	    @param num the number of lastfiles to set.
 	*/
-	void readFile(string const &);
-	/// used by the constructor to set the number of stored last files.
-        void setNumberOfFiles(unsigned int num);
+	void setNumberOfFiles(unsigned int num);
 };
 #endif