doxygen update

2 files changed, 29 insertions, 5 deletions

diff --git a/include/sitecing/sitecing_enflesher.h b/include/sitecing/sitecing_enflesher.h
index db15bc3..9eefdcc 100644
--- a/include/sitecing/sitecing_enflesher.h
+++ b/include/sitecing/sitecing_enflesher.h
@@ -10,12 +10,15 @@ using namespace std;
  * @brief The preprocessed source builder.
  */
 
 #ifndef sitecing_enflesher_flexlexer_once
 #define sitecing_enflesher_flexlexer_once
 #undef yyFlexLexer
+/**
+ * nevermind me
+ */
 #define yyFlexLexer sitecing_enflesherFlexLexer
 #include <FlexLexer.h>
 #undef yyFlexLexerOnce
 #endif
 
 class sitecing_parser;
@@ -23,17 +26,17 @@ class sitecing_parser;
  * The enfleshing of the skeleton file according to the in-memory parsed
  * component source.
  */
 class sitecing_enflesher : public sitecing_enflesherFlexLexer {
     public:
         /**
-         * It is time to anchor output with the #line directive.
+         * It is time to anchor output with the \#line directive.
          */
         bool anchor_time;
         /**
-         * The file currently being written is supposed to have #line
+         * The file currently being written is supposed to have \#line
          * directives all around the place.
          */
         bool anchoraged;
         /**
          * The reference to the parser object containg the parsed source.
          */
@@ -56,17 +59,26 @@ class sitecing_enflesher : public sitecing_enflesherFlexLexer {
 
         /**
          * Do the job.
          */
         void enflesh();
 
+        /**
+         * 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();
 
         /**
-         * Put a #line anchor into output.
+         * Put a \#line anchor into output.
          */
         void anchor();
 
         /**
          * Close previously opened output stream, rename to the 'correct'
          * destination filename, if needed, and open new file.
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
@@ -15,12 +15,15 @@ using namespace sitecing;
  * @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
 
 /**
@@ -308,27 +311,36 @@ class sitecing_parser : public sitecing_parserFlexLexer {
         /**
          * 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 */