author | Michael Krelin <hacker@klever.net> | 2007-03-04 00:51:48 (UTC) |
---|---|---|
committer | Michael Krelin <hacker@klever.net> | 2007-03-04 00:51:48 (UTC) |
commit | 8677376c6669ad29bf24e237f626fd8296558f9b (patch) (side-by-side diff) | |
tree | 1690b574355458356ea87a66387db1758c2ac9b1 | |
parent | a3f38aafb288db5791b8dea34154cacc3c039971 (diff) | |
download | sitecing-8677376c6669ad29bf24e237f626fd8296558f9b.zip sitecing-8677376c6669ad29bf24e237f626fd8296558f9b.tar.gz sitecing-8677376c6669ad29bf24e237f626fd8296558f9b.tar.bz2 |
doxygen update
-rw-r--r-- | include/sitecing/sitecing_enflesher.h | 18 | ||||
-rw-r--r-- | include/sitecing/sitecing_parser.h | 16 |
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 @@ -14,4 +14,7 @@ using namespace std; #define sitecing_enflesher_flexlexer_once #undef yyFlexLexer +/** + * nevermind me + */ #define yyFlexLexer sitecing_enflesherFlexLexer #include <FlexLexer.h> @@ -27,9 +30,9 @@ 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. */ @@ -60,9 +63,18 @@ 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 @@ -19,4 +19,7 @@ using namespace sitecing; #define sitecing_parser_flexlexer_once #undef yyFlexLexer +/** + * nevermind me + */ #define yyFlexLexer sitecing_parserFlexLexer #include <FlexLexer.h> @@ -312,5 +315,14 @@ 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(); @@ -323,9 +335,9 @@ class sitecing_parser : public sitecing_parserFlexLexer { } /** - * 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(); |