summaryrefslogtreecommitdiffabout
path: root/include
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) (unidiff)
treeb7f735ef9fde95de5935c1784d8d9486a3e4cf10 /include
parentca2207bcf18ed5b0dd1a0e370e9973d717ff87c9 (diff)
downloadsitecing-a3f38aafb288db5791b8dea34154cacc3c039971.zip
sitecing-a3f38aafb288db5791b8dea34154cacc3c039971.tar.gz
sitecing-a3f38aafb288db5791b8dea34154cacc3c039971.tar.bz2
some doxygen improvements
Diffstat (limited to 'include') (more/less context) (ignore whitespace changes)
-rw-r--r--include/sitecing/cgi_component.h11
-rw-r--r--include/sitecing/component_factory.h14
-rw-r--r--include/sitecing/component_so.h6
-rw-r--r--include/sitecing/configuration.h23
-rw-r--r--include/sitecing/file_factory.h4
-rw-r--r--include/sitecing/process_manager.h2
-rw-r--r--include/sitecing/scoreboard.h3
-rw-r--r--include/sitecing/sitecing_parser.h6
-rw-r--r--include/sitecing/sitecing_util.h24
-rw-r--r--include/sitecing/util.h4
10 files changed, 63 insertions, 34 deletions
diff --git a/include/sitecing/cgi_component.h b/include/sitecing/cgi_component.h
index 91df689..0cad438 100644
--- a/include/sitecing/cgi_component.h
+++ b/include/sitecing/cgi_component.h
@@ -32,19 +32,10 @@ namespace sitecing {
32 virtual ~cgi_component(); 32 virtual ~cgi_component();
33 33
34 /**
35 * @overload acomponent::__set_interface()
36 */
37 void __set_interface(sitecing_interface* scif); 34 void __set_interface(sitecing_interface* scif);
38 /** 35 void __on_change_interface(sitecing_interface *oscif);
39 * @overload acomponent::__on_change_interface()
40 */
41 void __on_change_interface(sitecing_interface *o);
42 /** 36 /**
43 * Invoked on the change of the interface to the CGI. 37 * Invoked on the change of the interface to the CGI.
44 */ 38 */
45 virtual void __on_change_CGI(kingate::cgi_gateway *o); 39 virtual void __on_change_CGI(kingate::cgi_gateway *o);
46 /**
47 * @overload acomponent::__on_imports()
48 */
49 virtual void __on_imports(); 40 virtual void __on_imports();
50 }; 41 };
diff --git a/include/sitecing/component_factory.h b/include/sitecing/component_factory.h
index 9ddf70d..8f103e0 100644
--- a/include/sitecing/component_factory.h
+++ b/include/sitecing/component_factory.h
@@ -43,19 +43,7 @@ namespace sitecing {
43 component_factory(configuration& c); 43 component_factory(configuration& c);
44 44
45 /**
46 * @overload file_factory::get_dependencies()
47 */
48 virtual void get_dependencies(const string& dst,file_list_t& deps); 45 virtual void get_dependencies(const string& dst,file_list_t& deps);
49 /** 46 virtual bool is_uptodate(const string& dst,file_list_t *deps=0);
50 * @overload file_factory::is_uptodate()
51 */
52 virtual bool is_uptodate(const string& dst,file_list_t *deps=NULL);
53 /**
54 * @overload file_factory::build()
55 */
56 virtual void build(const string& dst); 47 virtual void build(const string& dst);
57 /**
58 * @overload file_factory::make()
59 */
60 virtual void make(const string& dst); 48 virtual void make(const string& dst);
61 49
diff --git a/include/sitecing/component_so.h b/include/sitecing/component_so.h
index 3239d4a..3daceef 100644
--- a/include/sitecing/component_so.h
+++ b/include/sitecing/component_so.h
@@ -150,4 +150,10 @@ namespace sitecing {
150 so_component_t(const so_component& s) 150 so_component_t(const so_component& s)
151 : so_component(s) { } 151 : so_component(s) { }
152
153 /**
154 * typed dereference operator
155 * @return the pointer to the most derived component instance
156 * @see acomponent::__the_most_derived_this()
157 */
152 CT* operator->() { 158 CT* operator->() {
153 return static_cast<CT*>(ac->__the_most_derived_this()); 159 return static_cast<CT*>(ac->__the_most_derived_this());
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
@@ -145,6 +145,15 @@ namespace sitecing {
145 list<string> args; 145 list<string> args;
146 146
147 /**
148 * @param s regex pattern
149 * @param a action handler
150 */
147 action_handler_t(const string& s,const string& a) 151 action_handler_t(const string& s,const string& a)
148 : s_regex(s), regex(s), action(a) { } 152 : s_regex(s), regex(s), action(a) { }
153 /**
154 * Copy constructor
155 *
156 * @param s source object
157 */
149 action_handler_t(const action_handler_t& s) 158 action_handler_t(const action_handler_t& s)
150 : s_regex(s.s_regex), regex(s.regex), action (s.action), args(s.args) { } 159 : s_regex(s.s_regex), regex(s.regex), action (s.action), args(s.args) { }
@@ -219,5 +228,5 @@ namespace sitecing {
219 * Load the configuration file. 228 * Load the configuration file.
220 * @param config the main configuration container. 229 * @param config the main configuration container.
221 * @param the configuration file. 230 * @param cfile the configuration file.
222 */ 231 */
223 void parse(configuration *config,const string& cfile); 232 void parse(configuration *config,const string& cfile);
@@ -299,5 +308,5 @@ namespace sitecing {
299 flag_user = 0x00000800, 308 flag_user = 0x00000800,
300 /** 309 /**
301 * @Was the group specified? 310 * Was the group specified?
302 * @see group 311 * @see group
303 */ 312 */
@@ -391,4 +400,8 @@ namespace sitecing {
391 bool daemonize; 400 bool daemonize;
392 401
402 /**
403 * Type for the config options map
404 * @see specs
405 */
393 typedef map<string,config_options> specs_t; 406 typedef map<string,config_options> specs_t;
394 /** 407 /**
@@ -396,4 +409,8 @@ namespace sitecing {
396 */ 409 */
397 specs_t specs; 410 specs_t specs;
411 /**
412 * Type for the loaded per-dir config map
413 * @see loaded_specs
414 */
398 typedef map<string,loaded_options> loaded_specs_t; 415 typedef map<string,loaded_options> loaded_specs_t;
399 /** 416 /**
@@ -406,5 +423,5 @@ namespace sitecing {
406 /** 423 /**
407 * @param cfile the configuration file. 424 * @param cfile the configuration file.
408 * @param ab @todo TODO:: document me 425 * @param ab document me @todo TODO:: document me
409 */ 426 */
410 configuration(const string& cfile,bool ab=false); 427 configuration(const string& cfile,bool ab=false);
diff --git a/include/sitecing/file_factory.h b/include/sitecing/file_factory.h
index 7ec82da..43a27bb 100644
--- a/include/sitecing/file_factory.h
+++ b/include/sitecing/file_factory.h
@@ -33,5 +33,5 @@ namespace sitecing {
33 /** 33 /**
34 * Fetch depndencies for the given file. 34 * Fetch depndencies for the given file.
35 * @param dst destination file. 35 * @param dst the destination file.
36 * @param deps where to put dependencies to. 36 * @param deps where to put dependencies to.
37 */ 37 */
@@ -39,5 +39,5 @@ namespace sitecing {
39 /** 39 /**
40 * Check if the destination is up to day. 40 * Check if the destination is up to day.
41 * @param the destination file. 41 * @param dst the destination file.
42 * @param deps if the deps pointer is non there, the dependencies 42 * @param deps if the deps pointer is non there, the dependencies
43 * retrieved will be stored there. 43 * retrieved will be stored there.
diff --git a/include/sitecing/process_manager.h b/include/sitecing/process_manager.h
index 73415d3..921f159 100644
--- a/include/sitecing/process_manager.h
+++ b/include/sitecing/process_manager.h
@@ -55,5 +55,5 @@ namespace sitecing {
55 /** 55 /**
56 * The worker function. 56 * The worker function.
57 * @param the slot allocated for the process. 57 * @param slot the slot allocated for the process.
58 */ 58 */
59 virtual void process(int slot) = 0; 59 virtual void process(int slot) = 0;
diff --git a/include/sitecing/scoreboard.h b/include/sitecing/scoreboard.h
index 788f881..1371ab1 100644
--- a/include/sitecing/scoreboard.h
+++ b/include/sitecing/scoreboard.h
@@ -46,4 +46,7 @@ namespace sitecing {
46 state_processing 46 state_processing
47 } state; 47 } state;
48 /**
49 * Process ID
50 */
48 pid_t pid; 51 pid_t pid;
49 }; 52 };
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
@@ -89,5 +89,6 @@ class sitecing_parser : public sitecing_parserFlexLexer {
89 * @param i initializer. 89 * @param i initializer.
90 * @param bc whether it is a component. 90 * @param bc whether it is a component.
91 * @param bto @todo TODO: @see bTypeOnly. 91 * @param bto document me @todo TODO:
92 * @see bTypeOnly.
92 */ 93 */
93 member_variable(const string& t,const string& n,const string& i,bool bc = false,bool bto = false) 94 member_variable(const string& t,const string& n,const string& i,bool bc = false,bool bto = false)
@@ -222,6 +223,5 @@ class sitecing_parser : public sitecing_parserFlexLexer {
222 223
223 /** 224 /**
224 * @param flags. 225 * @param f processing flags @see flags
225 * @see flags
226 */ 226 */
227 modus_operandi(int f = 0) 227 modus_operandi(int f = 0)
diff --git a/include/sitecing/sitecing_util.h b/include/sitecing/sitecing_util.h
index f642c74..233292c 100644
--- a/include/sitecing/sitecing_util.h
+++ b/include/sitecing/sitecing_util.h
@@ -20,4 +20,10 @@ namespace sitecing {
20 class utility_error : public konforka::exception { 20 class utility_error : public konforka::exception {
21 public: 21 public:
22 /**
23 * @param fi file name
24 * @param fu function name
25 * @param l line number
26 * @param w what
27 */
22 utility_error(const string& fi,const string& fu,int l,const string& w) 28 utility_error(const string& fi,const string& fu,int l,const string& w)
23 : konforka::exception(fi,fu,l,w) { } 29 : konforka::exception(fi,fu,l,w) { }
@@ -29,4 +35,10 @@ namespace sitecing {
29 class utility_no_affix : public utility_error { 35 class utility_no_affix : public utility_error {
30 public: 36 public:
37 /**
38 * @param fi file name
39 * @param fu function name
40 * @param l line number
41 * @param w what
42 */
31 utility_no_affix(const string& fi,const string& fu,int l,const string& w) 43 utility_no_affix(const string& fi,const string& fu,int l,const string& w)
32 : utility_error(fi,fu,l,w) { } 44 : utility_error(fi,fu,l,w) { }
@@ -37,4 +49,10 @@ namespace sitecing {
37 class utility_no_prefix : public utility_no_affix { 49 class utility_no_prefix : public utility_no_affix {
38 public: 50 public:
51 /**
52 * @param fi file name
53 * @param fu function name
54 * @param l line number
55 * @param w what
56 */
39 utility_no_prefix(const string& fi,const string& fu,int l,const string& w) 57 utility_no_prefix(const string& fi,const string& fu,int l,const string& w)
40 : utility_no_affix(fi,fu,l,w) { } 58 : utility_no_affix(fi,fu,l,w) { }
@@ -45,4 +63,10 @@ namespace sitecing {
45 class utility_no_suffix : public utility_no_affix { 63 class utility_no_suffix : public utility_no_affix {
46 public: 64 public:
65 /**
66 * @param fi file name
67 * @param fu function name
68 * @param l line number
69 * @param w what
70 */
47 utility_no_suffix(const string& fi,const string& fu,int l,const string& w) 71 utility_no_suffix(const string& fi,const string& fu,int l,const string& w)
48 : utility_no_affix(fi,fu,l,w) { } 72 : utility_no_affix(fi,fu,l,w) { }
diff --git a/include/sitecing/util.h b/include/sitecing/util.h
index 5750ab6..a38ae90 100644
--- a/include/sitecing/util.h
+++ b/include/sitecing/util.h
@@ -23,5 +23,5 @@ namespace sitecing {
23 html_escape_nbsp = 0x0001, 23 html_escape_nbsp = 0x0001,
24 /** 24 /**
25 * Turn newlines into <br/> or <br>. 25 * Turn newlines into br/ or br.
26 */ 26 */
27 html_escape_br = 0x0002, 27 html_escape_br = 0x0002,
@@ -31,5 +31,5 @@ namespace sitecing {
31 html_escape_quot = 0x0004, 31 html_escape_quot = 0x0004,
32 /** 32 /**
33 * Do not put '/' into <br/> consruct. 33 * Do not put '/' into br consruct.
34 */ 34 */
35 html_escape_br_noslash = 0x0008 35 html_escape_br_noslash = 0x0008