some doxygen improvements

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
@@ -33,10 +33,4 @@ namespace sitecing {
 
-            /**
-             * @overload acomponent::__set_interface()
-             */
             void __set_interface(sitecing_interface* scif);
-            /**
-             * @overload acomponent::__on_change_interface()
-             */
-            void __on_change_interface(sitecing_interface *o);
+            void __on_change_interface(sitecing_interface *oscif);
             /**
@@ -45,5 +39,2 @@ namespace sitecing {
             virtual void __on_change_CGI(kingate::cgi_gateway *o);
-            /**
-             * @overload acomponent::__on_imports()
-             */
             virtual void __on_imports();
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
@@ -44,17 +44,5 @@ namespace sitecing {
 
-            /**
-             * @overload file_factory::get_dependencies()
-             */
             virtual void get_dependencies(const string& dst,file_list_t& deps);
-            /**
-             * @overload file_factory::is_uptodate()
-             */
-            virtual bool is_uptodate(const string& dst,file_list_t *deps=NULL);
-            /**
-             * @overload file_factory::build()
-             */
+            virtual bool is_uptodate(const string& dst,file_list_t *deps=0);
             virtual void build(const string& dst);
-            /**
-             * @overload file_factory::make()
-             */
             virtual void make(const string& dst);
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
@@ -151,2 +151,8 @@ namespace sitecing {
                     : so_component(s) { }
+
+                /**
+                 * typed dereference operator
+                 * @return the pointer to the most derived component instance
+                 * @see acomponent::__the_most_derived_this()
+                 */
                 CT* operator->() {
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
@@ -146,4 +146,13 @@ namespace sitecing {
 
+                /**
+                 * @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)
@@ -220,3 +229,3 @@ namespace sitecing {
              * @param config the main configuration container.
-             * @param the configuration file.
+             * @param cfile the configuration file.
              */
@@ -300,3 +309,3 @@ namespace sitecing {
                 /**
-                 * @Was the group specified?
+                 * Was the group specified?
                  * @see group
@@ -392,2 +401,6 @@ namespace sitecing {
 
+            /**
+             * Type for the config options map
+             * @see specs
+             */
             typedef map<string,config_options> specs_t;
@@ -397,2 +410,6 @@ namespace sitecing {
             specs_t specs;
+            /**
+             * Type for the loaded per-dir config map
+             * @see loaded_specs
+             */
             typedef map<string,loaded_options> loaded_specs_t;
@@ -407,3 +424,3 @@ namespace sitecing {
              * @param cfile the configuration file.
-             * @param ab @todo TODO:: document me
+             * @param ab document me @todo TODO:: document me
              */
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
@@ -34,3 +34,3 @@ namespace sitecing {
              * Fetch depndencies for the given file.
-             * @param dst destination file.
+             * @param dst the destination file.
              * @param deps where to put dependencies to.
@@ -40,3 +40,3 @@ namespace sitecing {
              * Check if the destination is up to day.
-             * @param the destination file.
+             * @param dst the destination file.
              * @param deps if the deps pointer is non there, the dependencies
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
@@ -56,3 +56,3 @@ namespace sitecing {
              * The worker function.
-             * @param the slot allocated for the process.
+             * @param slot the slot allocated for the process.
              */
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
@@ -47,2 +47,5 @@ namespace sitecing {
         }   state;
+        /**
+         * Process ID
+         */
         pid_t pid;
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
@@ -90,3 +90,4 @@ class sitecing_parser : public sitecing_parserFlexLexer {
                  * @param bc whether it is a component.
-                 * @param bto @todo TODO: @see bTypeOnly.
+                 * @param bto document me @todo TODO:
+                 * @see bTypeOnly.
                  */
@@ -223,4 +224,3 @@ class sitecing_parser : public sitecing_parserFlexLexer {
                 /**
-                 * @param flags.
-                 * @see flags
+                 * @param f processing flags @see flags
                  */
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
@@ -21,2 +21,8 @@ namespace sitecing {
         public:
+            /**
+             * @param fi file name
+             * @param fu function name
+             * @param l line number
+             * @param w what
+             */
             utility_error(const string& fi,const string& fu,int l,const string& w)
@@ -30,2 +36,8 @@ namespace sitecing {
         public:
+            /**
+             * @param fi file name
+             * @param fu function name
+             * @param l line number
+             * @param w what
+             */
             utility_no_affix(const string& fi,const string& fu,int l,const string& w)
@@ -38,2 +50,8 @@ namespace sitecing {
         public:
+            /**
+             * @param fi file name
+             * @param fu function name
+             * @param l line number
+             * @param w what
+             */
             utility_no_prefix(const string& fi,const string& fu,int l,const string& w)
@@ -46,2 +64,8 @@ namespace sitecing {
         public:
+            /**
+             * @param fi file name
+             * @param fu function name
+             * @param l line number
+             * @param w what
+             */
             utility_no_suffix(const string& fi,const string& fu,int l,const string& 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
@@ -24,3 +24,3 @@ namespace sitecing {
         /**
-         * Turn newlines into <br/> or <br>.
+         * Turn newlines into br/ or br.
          */
@@ -32,3 +32,3 @@ namespace sitecing {
         /**
-         * Do not put '/' into <br/> consruct.
+         * Do not put '/' into br consruct.
          */