]> git.lyx.org Git - lyx.git/blobdiff - src/lyxlex.h
Point fix, earlier forgotten
[lyx.git] / src / lyxlex.h
index f884ccd8ebcb622797022b1fcc6b84daebf6d4a9..32c58834437fcd525005e143beab32a27a107abe 100644 (file)
@@ -1,16 +1,22 @@
 // -*- C++ -*-
+/**
+ * \file lyxlex.h
+ * This file is part of LyX, the document processor.
+ * Licence details can be found in the file COPYING.
+ *
+ * \author Alejandro Aguilar Sierra
+ * \author Lars Gullik Bjønnes
+ *
+ * Full author contact details are available in file CREDITS.
+ */
+
 //  Generalized simple lexical analizer.
 //  It can be used for simple syntax parsers, like lyxrc,
-//  texclass and others to come.   [asierra30/03/96]
-//
-//   Copyright 1996 Lyx Team.
+//  texclass and others to come.
+
 #ifndef LYXLEX_H
 #define LYXLEX_H
 
-#ifdef __GNUG__
-#pragma interface
-#endif
-
 #include <iosfwd>
 
 #include "LString.h"
@@ -29,13 +35,13 @@ struct keyword_item {
     texclass and others to come.
     @see lyxrc.C for an example of usage.
   */
-class LyXLex : boost::noncopyable { 
+class LyXLex : boost::noncopyable {
 public:
        ///
-       LyXLex (keyword_item *, int);
+       LyXLex(keyword_item *, int);
        ///
        ~LyXLex();
-       
+
        /// Lex basic codes
        enum {
                ///
@@ -53,7 +59,7 @@ public:
        /// return true if able to open file, else false
        bool setFile(string const & filename);
        ///
-       void setStream(std::istream & i);
+       void setStream(std::istream & is);
        ///
        std::istream & getStream();
        /// Danger! Don't use it unless you know what you are doing.
@@ -76,10 +82,10 @@ public:
        bool nextToken();
        /// Push a token, that next token got from lyxlex.
        void pushToken(string const &);
-       
-       /// 
+
+       ///
        int getLineNo() const;
-       
+
        ///
        int getInteger() const;
        ///
@@ -88,7 +94,7 @@ public:
        float getFloat() const;
        ///
        string const getString() const;
-       
+
        /** Get a long string, ended by the tag `endtag'.
            This string can span several lines. The first line
            serves as a template for how many spaces the lines
@@ -97,19 +103,16 @@ public:
            perfectly if you use tabs.
        */
        string const getLongString(string const & endtag);
-       
+
        ///
        bool eatLine();
        ///
        int findToken(char const * str[]);
 
-       ///
-       string const text() const;
-
        /** Pushes a token list on a stack and replaces it with a new one.
         */
        void pushTable(keyword_item *, int);
-       
+
        /** Pops a token list into void and replaces it with the one now
            on top of the stack.
        */