summaryrefslogtreecommitdiffabout
path: root/include/sitecing/sitecing_enflesher.h
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/sitecing/sitecing_enflesher.h
parenta3f38aafb288db5791b8dea34154cacc3c039971 (diff)
downloadsitecing-8677376c6669ad29bf24e237f626fd8296558f9b.zip
sitecing-8677376c6669ad29bf24e237f626fd8296558f9b.tar.gz
sitecing-8677376c6669ad29bf24e237f626fd8296558f9b.tar.bz2
doxygen update
Diffstat (limited to 'include/sitecing/sitecing_enflesher.h') (more/less context) (ignore whitespace changes)
-rw-r--r--include/sitecing/sitecing_enflesher.h18
1 files changed, 15 insertions, 3 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
@@ -8,34 +8,37 @@ using namespace std;
/**
* @file
* @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;
/**
* 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.
*/
sitecing_parser& parser;
/**
@@ -54,21 +57,30 @@ class sitecing_enflesher : public sitecing_enflesherFlexLexer {
sitecing_enflesher(sitecing_parser& p)
: parser(p), anchor_time(true) { }
/**
* 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.
* @see outs
* @see outs_filename