From 8677376c6669ad29bf24e237f626fd8296558f9b Mon Sep 17 00:00:00 2001 From: Michael Krelin Date: Sun, 04 Mar 2007 00:51:48 +0000 Subject: doxygen update --- 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 @@ -13,6 +13,9 @@ using namespace std; #ifndef sitecing_enflesher_flexlexer_once #define sitecing_enflesher_flexlexer_once #undef yyFlexLexer +/** + * nevermind me + */ #define yyFlexLexer sitecing_enflesherFlexLexer #include #undef yyFlexLexerOnce @@ -26,11 +29,11 @@ class sitecing_parser; 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; @@ -59,11 +62,20 @@ class sitecing_enflesher : public sitecing_enflesherFlexLexer { */ 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(); 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 @@ -18,6 +18,9 @@ using namespace sitecing; #ifndef sitecing_parser_flexlexer_once #define sitecing_parser_flexlexer_once #undef yyFlexLexer +/** + * nevermind me + */ #define yyFlexLexer sitecing_parserFlexLexer #include #undef yyFlexLexerOnce @@ -311,7 +314,16 @@ class sitecing_parser : public sitecing_parserFlexLexer { */ 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(); /** @@ -322,11 +334,11 @@ class sitecing_parser : public sitecing_parserFlexLexer { 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(); }; -- cgit v0.9.0.2