X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2Fchset.h;h=a3691af1df5e1308193ad97a60cf4d27f35f69b8;hb=98c966c64594611e469313314abd1e59524adb4a;hp=9fcef19ab6889f2f3ee000e52e3dbeed50053b96;hpb=85798535a19919e82cc94a177a8414c542a9c5bf;p=lyx.git

diff --git a/src/chset.h b/src/chset.h
index 9fcef19ab6..a3691af1df 100644
--- a/src/chset.h
+++ b/src/chset.h
@@ -1,4 +1,10 @@
 // -*- C++ -*-
+/**
+ * \file chset.h
+ * Copyright 2002 the LyX Team
+ * Read the file COPYING
+ */
+
 #ifndef CHSET_H
 #define CHSET_H
 
@@ -11,24 +17,33 @@
 
 #include "LString.h"
 
-using std::map;
-using std::pair;
-
-///
+/// a class for mapping char strings such as "\^{A}" to the integer value
 class CharacterSet {
 public:
-	///
-	bool loadFile(string 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(string const & charset);
+	/// return the name of the current charset
 	string const & getName() const;
-	///
-	pair<bool, int> encodeString(string &) 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(string const &) const;
 private:
-	///
+	/// charset name
 	string name_;
 	///
-	typedef map<string, unsigned char> Cdef;
-	///
+	typedef std::map<string, unsigned char> Cdef;
+	/// mapping from string representation to encoded value
 	Cdef map_;
 };
 #endif