X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2Fchset.h;h=468ce2399540d2aee9d8b1f731370ff81dee9132;hb=78046794ccfce3a20751e00b35295c290853afd6;hp=73d49c84494ad3eb602805afdac6e0612d4b11ca;hpb=532141facfd18627e9972f7a4f3d2032d18e0d2c;p=lyx.git

diff --git a/src/chset.h b/src/chset.h
index 73d49c8449..468ce23995 100644
--- a/src/chset.h
+++ b/src/chset.h
@@ -1,31 +1,50 @@
 // -*- C++ -*-
+/**
+ * \file chset.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 Jean-Marc Lasgouttes
+ *
+ * Full author contact details are available in file CREDITS.
+ */
+
 #ifndef CHSET_H
 #define CHSET_H
 
-#ifdef __GNUG__
-#pragma interface
-#endif
-
 #include <map>
 #include <utility>
+#include <string>
 
-#include "LString.h"
 
-///
+/// a class for mapping char strings such as "\^{A}" to the integer value
 class CharacterSet {
 public:
-	///
-	bool loadFile(string const &);
-	///
-	string const & getName() const;
-	///
-	std::pair<bool, int> encodeString(string const &) const;
+	/**
+	 * initialise this charset from the given .cdef file
+	 * param charset the charset to look for
+	 *
+	 * Finds a .cdef file corresponding to the named charset
+	 * and parses it. This function is only intended to be
+	 * called once.
+	 */
+	bool loadFile(std::string const & charset);
+	/// return the name of the current charset
+	std::string const & getName() const;
+	/**
+	 * Return the encoded charset value of the given string.
+	 *
+	 * The bool value is false if an encoding could not be found
+	 * in this charset, and true otherwise.
+	 */
+	std::pair<bool, int> const encodeString(std::string const &) const;
 private:
+	/// charset name
+	std::string name_;
 	///
-	string name_;
-	///
-	typedef std::map<string, unsigned char> Cdef;
-	///
+	typedef std::map<std::string, unsigned char> Cdef;
+	/// mapping from string representation to encoded value
 	Cdef map_;
 };
 #endif