summaryrefslogtreecommitdiffabout
path: root/include
authorMichael Krelin <hacker@klever.net>2007-03-04 00:51:48 (UTC)
committer Michael Krelin <hacker@klever.net>2007-03-04 00:51:48 (UTC)
commit8677376c6669ad29bf24e237f626fd8296558f9b (patch) (side-by-side diff)
tree1690b574355458356ea87a66387db1758c2ac9b1 /include
parenta3f38aafb288db5791b8dea34154cacc3c039971 (diff)
downloadsitecing-8677376c6669ad29bf24e237f626fd8296558f9b.zip
sitecing-8677376c6669ad29bf24e237f626fd8296558f9b.tar.gz
sitecing-8677376c6669ad29bf24e237f626fd8296558f9b.tar.bz2
doxygen update
Diffstat (limited to 'include') (more/less context) (show whitespace changes)
-rw-r--r--include/sitecing/sitecing_enflesher.h18
-rw-r--r--include/sitecing/sitecing_parser.h16
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
@@ -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 <FlexLexer.h>
#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 <FlexLexer.h>
#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();
};