summaryrefslogtreecommitdiffabout
path: root/include/sitecing
Side-by-side diff
Diffstat (limited to 'include/sitecing') (more/less context) (ignore 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
@@ -12,8 +12,11 @@ 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
#endif
@@ -25,13 +28,13 @@ 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;
/**
@@ -58,13 +61,22 @@ 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();
/**
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
@@ -17,8 +17,11 @@ 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
#endif
@@ -310,9 +313,18 @@ class sitecing_parser : public sitecing_parserFlexLexer {
* @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.
@@ -321,13 +333,13 @@ class sitecing_parser : public sitecing_parserFlexLexer {
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();
};