1 files changed, 14 insertions, 2 deletions

diff --git a/include/sitecing/sitecing_parser.h b/include/sitecing/sitecing_parser.h
index a53ef22..bcabc5c 100644
--- a/include/sitecing/sitecing_parser.h
+++ b/include/sitecing/sitecing_parser.h
@@ -1,116 +1,119 @@
 #ifndef __SITECING_SITECING_PARSER_H
 #define __SITECING_SITECING_PARSER_H
 
 #include <string>
 #include <list>
 #include <map>
 #include <stdexcept>
 using namespace std;
 
 #include "sitecing/component_factory.h"
 using namespace sitecing;
 
 /**
  * @file
  * @brief The component source parser.
  */
 
 #ifndef sitecing_parser_flexlexer_once
 #define sitecing_parser_flexlexer_once
 #undef yyFlexLexer
+/**
+ * nevermind me
+ */
 #define yyFlexLexer sitecing_parserFlexLexer
 #include <FlexLexer.h>
 #undef yyFlexLexerOnce
 #endif
 
 /**
  * The component source parser.
  */
 class sitecing_parser : public sitecing_parserFlexLexer {
     public:
 	/**
 	 * The ancestor class definition.
 	 */
 	class ancestor_class {
 	    public:
 		/**
 		 * The class name.
 		 */
 		string name;
 		/**
 		 * The source component path.
 		 */
 		string path;
 
 		/**
 		 * @param n the class name.
 		 * @param p the component path.
 		 */
 		ancestor_class(const string& n,const string& p)
 		    : name(n), path(p) { }
 	};
 	/**
 	 * The list of ancestor classes.
 	 */
 	typedef list<ancestor_class> ancestor_classes_t;
 	/**
 	 * The ancestor classes.
 	 */
 	ancestor_classes_t ancestor_classes;
 	/**
 	 * The member variable definition.
 	 */
 	class member_variable {
 	    public:
 		/**
 		 * The member variable type.
 		 */
 		string type;
 		/**
 		 * The member variable name.
 		 */
 		string name;
 		/**
 		 * The member variable is a component.
 		 */
 		bool bComponent;
 		/**
 		 * The variable initializer.
 		 */
 		string initializer;
 		/**
 		 * @todo TODO: wish I could remember -- document me.
 		 */
 		bool bTypeOnly;
 
 		/**
 		 * @param t type.
 		 * @param n name.
 		 * @param i initializer.
 		 * @param bc whether it is a component.
 		 * @param bto document me @todo TODO:
 		 * @see bTypeOnly.
 		 */
 		member_variable(const string& t,const string& n,const string& i,bool bc = false,bool bto = false)
 		    : type(t), name(n), initializer(i), bComponent(bc), bTypeOnly(bto) { }
 	};
 	/**
 	 * The list of member variables.
 	 */
 	typedef list<member_variable> member_variables_t;
 	/**
 	 * Member variables.
 	 */
 	member_variables_t member_variables;
 	/**
 	 * @todo TODO: wish I could remember the details -- document me.
 	 */
 	bool have_initializers;
 	/**
 	 * Whether the component has a constructor defined.
 	 */
 	bool have_constructor;
 	/**
 	 * Member function definition.
 	 */
 	class member_function {
@@ -218,117 +221,126 @@ class sitecing_parser : public sitecing_parserFlexLexer {
 		string _name;
 		/**
 		 * The argument declaration. Obviously for member functions.
 		 */
 		string _args;
 
 		/**
 		 * @param f processing flags @see flags
 		 */
 		modus_operandi(int f = 0)
 		    : modus(modus_code), flags(f) { }
 
 		/**
 		 * Change the processing mode.
 		 */
 		void modify(modus_t m);
 
 		/**
 		 * See if we're eating up whitespaces.
 		 */
 		bool devour_whitespace() { return flags&flag_devour_whitespace; }
 		/**
 		 * See if we're eating up the comments.
 		 */
 		bool devour_comments() { return flags&flag_devour_comments; }
 	};
 	/**
 	 * The modes stack type.
 	 */
 	typedef list<modus_operandi> modi_operandi;
 	/**
 	 * The modes stack.
 	 */
 	modi_operandi modi;
 	/**
 	 * Input file name.
 	 */
 	string input_file;
 	/**
 	 * Base class name.
 	 */
 	string base_class;
 	/**
 	 * Base class header.
 	 */
 	string base_header;
 	/**
 	 * Component's basename.
 	 * @todo TODO: wish I could remember the details -- document me.
 	 */
 	string component_basename;
 	/**
 	 * The skeleton file name.
 	 */
 	string skeleton;
 	/**
 	 * The component class name.
 	 */
 	string class_name;
 	/**
 	 * Output basename.
 	 * @todo TODO: wish I could remember the details -- document me.
 	 */
 	string output_basename;
 	/**
 	 * Verbatim declaration part.
 	 */
 	string decl;
 	/**
 	 * Verbatim implementation part.
 	 */
 	string impl;
 	/**
 	 * The reference to the component factory object.
 	 */
 	component_factory& factory;
 	/**
 	 * Pragma map type.
 	 */
 	typedef map<string,string> pragmas_t;
 	/**
 	 * Pragma's found in the component.
 	 */
 	pragmas_t pragmas;
 
 	/**
 	 * @param f the component factory.
 	 */
 	sitecing_parser(component_factory& f);
 
 	/**
 	 * Preprocess file.
 	 * @param in input file name.
 	 */
 	void preprocess(const string& in);
 
+	/**
+	 * Output parsed data
+	 * @param buf pointer to the data
+	 * @param size length of the buffer pointed by buf
+	 */
 	virtual void LexerOutput(const char *buf,int size);
+	/**
+	 * Lexer generated by flex
+	 * @return zero on success
+	 */
 	virtual int yylex();
 
 	/**
 	 * Retrieve reference to the to of the modes stack.
 	 * @return the reference in question.
 	 */
 	modus_operandi& M() {
 	    return modi.front();
 	}
 	/**
-	 * Anchor the output with the #line, if we're not in the text output mode.
+	 * Anchor the output with the \#line, if we're not in the text output mode.
 	 */
 	void soft_anchor();
 	/**
-	 * Anchor the output with the #line directive, changing to the appropriate output mode if needed.
+	 * Anchor the output with the \#line directive, changing to the appropriate output mode if needed.
 	 */
 	void anchor();
 };
 
 #endif /* __SITECING_SITECING_PARSER_H */