summaryrefslogtreecommitdiffabout
path: root/include/sitecing/configuration.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/configuration.h
parentca2207bcf18ed5b0dd1a0e370e9973d717ff87c9 (diff)
downloadsitecing-a3f38aafb288db5791b8dea34154cacc3c039971.zip
sitecing-a3f38aafb288db5791b8dea34154cacc3c039971.tar.gz
sitecing-a3f38aafb288db5791b8dea34154cacc3c039971.tar.bz2
some doxygen improvements
Diffstat (limited to 'include/sitecing/configuration.h') (more/less context) (show whitespace changes)
-rw-r--r--include/sitecing/configuration.h23
1 files changed, 20 insertions, 3 deletions
diff --git a/include/sitecing/configuration.h b/include/sitecing/configuration.h
index 330a5a6..a2bf612 100644
--- a/include/sitecing/configuration.h
+++ b/include/sitecing/configuration.h
@@ -144,8 +144,17 @@ namespace sitecing {
*/
list<string> args;
+ /**
+ * @param s regex pattern
+ * @param a action handler
+ */
action_handler_t(const string& s,const string& a)
: s_regex(s), regex(s), action(a) { }
+ /**
+ * Copy constructor
+ *
+ * @param s source object
+ */
action_handler_t(const action_handler_t& s)
: s_regex(s.s_regex), regex(s.regex), action (s.action), args(s.args) { }
};
@@ -218,7 +227,7 @@ namespace sitecing {
/**
* Load the configuration file.
* @param config the main configuration container.
- * @param the configuration file.
+ * @param cfile the configuration file.
*/
void parse(configuration *config,const string& cfile);
};
@@ -298,7 +307,7 @@ namespace sitecing {
*/
flag_user = 0x00000800,
/**
- * @Was the group specified?
+ * Was the group specified?
* @see group
*/
flag_group = 0x00001000,
@@ -390,11 +399,19 @@ namespace sitecing {
*/
bool daemonize;
+ /**
+ * Type for the config options map
+ * @see specs
+ */
typedef map<string,config_options> specs_t;
/**
* The local config options map.
*/
specs_t specs;
+ /**
+ * Type for the loaded per-dir config map
+ * @see loaded_specs
+ */
typedef map<string,loaded_options> loaded_specs_t;
/**
* The local config options as specified in per-dir config files
@@ -405,7 +422,7 @@ namespace sitecing {
configuration();
/**
* @param cfile the configuration file.
- * @param ab @todo TODO:: document me
+ * @param ab document me @todo TODO:: document me
*/
configuration(const string& cfile,bool ab=false);