fix typo that put too many include paths for most people

[lyx.git] / src / chset.h

diff --git a/src/chset.h b/src/chset.h
index 90d9affad48156848b3a92da9195fa17f87d0373..a3691af1df5e1308193ad97a60cf4d27f35f69b8 100644 (file)
--- 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,21 +17,33 @@
 
 #include "LString.h"
 
-///
+/// 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;
-       ///
+       /**
+        * 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 std::map<string, unsigned char> Cdef;
-       ///
+       /// mapping from string representation to encoded value
        Cdef map_;
 };
 #endif