summaryrefslogtreecommitdiffabout
path: root/include/sitecing/sitecing_parser.h
authorMichael Krelin <hacker@klever.net>2007-03-04 00:28:39 (UTC)
committer Michael Krelin <hacker@klever.net>2007-03-04 00:28:39 (UTC)
commita3f38aafb288db5791b8dea34154cacc3c039971 (patch) (side-by-side diff)
treeb7f735ef9fde95de5935c1784d8d9486a3e4cf10 /include/sitecing/sitecing_parser.h
parentca2207bcf18ed5b0dd1a0e370e9973d717ff87c9 (diff)
downloadsitecing-a3f38aafb288db5791b8dea34154cacc3c039971.zip
sitecing-a3f38aafb288db5791b8dea34154cacc3c039971.tar.gz
sitecing-a3f38aafb288db5791b8dea34154cacc3c039971.tar.bz2
some doxygen improvements
Diffstat (limited to 'include/sitecing/sitecing_parser.h') (more/less context) (show whitespace changes)
-rw-r--r--include/sitecing/sitecing_parser.h6
1 files changed, 3 insertions, 3 deletions
diff --git a/include/sitecing/sitecing_parser.h b/include/sitecing/sitecing_parser.h
index a8474f3..a53ef22 100644
--- a/include/sitecing/sitecing_parser.h
+++ b/include/sitecing/sitecing_parser.h
@@ -67,49 +67,50 @@ class sitecing_parser : public sitecing_parserFlexLexer {
*/
string type;
/**
* The member variable name.
*/
string name;
/**
* The member variable is a component.
*/
bool bComponent;
/**
* The variable initializer.
*/
string initializer;
/**
* @todo TODO: wish I could remember -- document me.
*/
bool bTypeOnly;
/**
* @param t type.
* @param n name.
* @param i initializer.
* @param bc whether it is a component.
- * @param bto @todo TODO: @see bTypeOnly.
+ * @param bto document me @todo TODO:
+ * @see bTypeOnly.
*/
member_variable(const string& t,const string& n,const string& i,bool bc = false,bool bto = false)
: type(t), name(n), initializer(i), bComponent(bc), bTypeOnly(bto) { }
};
/**
* The list of member variables.
*/
typedef list<member_variable> member_variables_t;
/**
* Member variables.
*/
member_variables_t member_variables;
/**
* @todo TODO: wish I could remember the details -- document me.
*/
bool have_initializers;
/**
* Whether the component has a constructor defined.
*/
bool have_constructor;
/**
* Member function definition.
*/
class member_function {
@@ -200,50 +201,49 @@ class sitecing_parser : public sitecing_parserFlexLexer {
*/
int flags;
/**
* Output being built.
*/
string output;
/**
* The type for compound modes.
*/
string _type;
/**
* The last id encountered.
*/
string _lastid;
/**
* The name for compound modes.
*/
string _name;
/**
* The argument declaration. Obviously for member functions.
*/
string _args;
/**
- * @param flags.
- * @see flags
+ * @param f processing flags @see flags
*/
modus_operandi(int f = 0)
: modus(modus_code), flags(f) { }
/**
* Change the processing mode.
*/
void modify(modus_t m);
/**
* See if we're eating up whitespaces.
*/
bool devour_whitespace() { return flags&flag_devour_whitespace; }
/**
* See if we're eating up the comments.
*/
bool devour_comments() { return flags&flag_devour_comments; }
};
/**
* The modes stack type.
*/
typedef list<modus_operandi> modi_operandi;
/**
* The modes stack.