doxygen improvements

12 files changed, 9 insertions, 57 deletions

diff --git a/include/opkele/association.h b/include/opkele/association.h
index ef0df42..a8f3915 100644
--- a/include/opkele/association.h
+++ b/include/opkele/association.h
@@ -6,15 +6,12 @@
 
 /**
  * @file
  * @brief reference implementation of association_t
  */
 
-/**
- * @brief the main opkele namespace
- */
 namespace opkele {
 
     /**
      * reference implementation of association_t class.
      */
     class association : public association_t {
@@ -55,35 +52,17 @@ namespace opkele {
             association(const string& __server, const string& __handle,
                     const string& __assoc_type, const secret_t& __secret,
                     time_t __expires, bool __stateless)
                 : _server(__server), _handle(__handle), _assoc_type(__assoc_type),
                 _secret(__secret), _expires(__expires), _stateless(__stateless) { }
 
-            /**
-             * @overload association_t::server()
-             */
             virtual string server() const { return _server; }
-            /**
-             * @overload association_t::handle()
-             */
             virtual string handle() const { return _handle; }
-            /**
-             * @overload association_t::assoc_type()
-             */
             virtual string assoc_type() const { return _assoc_type; }
-            /**
-             * @overload association_t::secret()
-             */
             virtual secret_t secret() const { return _secret; }
-            /**
-             * @overload association_t::expires_in()
-             */
             virtual int expires_in() const { return _expires-time(0); }
-            /**
-             * @overload association_t::stateless()
-             */
             virtual bool stateless() const { return _stateless; }
     };
 
 }
 
 #endif /* __OPKELE_ASSOCIATION_H */
diff --git a/include/opkele/consumer.h b/include/opkele/consumer.h
index f32509e..fdb6119 100644
--- a/include/opkele/consumer.h
+++ b/include/opkele/consumer.h
@@ -6,15 +6,12 @@
 
 /**
  * @file
  * @brief OpenID consumer-side functionality
  */
 
-/**
- * @brief the main opkele namespace
- */
 namespace opkele {
 
     /**
      * implementation of basic consumer functionality
      */
     class consumer_t {
diff --git a/include/opkele/data.h b/include/opkele/data.h
index 7fc635b..d0b0516 100644
--- a/include/opkele/data.h
+++ b/include/opkele/data.h
@@ -1,11 +1,17 @@
 #ifndef __OPKELE_DATA_H
 #define __OPKELE_DATA_H
 
+/**
+ * @brief the main opkele namespace
+ */
 namespace opkele {
 
+    /**
+     * @brief internal data opkele namespace
+     */
     namespace data {
         extern const char *_default_p;
         extern const char *_default_g;
     }
 }
 
diff --git a/include/opkele/exception.h b/include/opkele/exception.h
index 9fc9bd3..0150e6b 100644
--- a/include/opkele/exception.h
+++ b/include/opkele/exception.h
@@ -50,15 +50,12 @@
 #endif /* OPKELE_HAVE_KONFORKA */
 /**
  * the exception parameters list to pass to constructor
  */
 # define OPKELE_E_CONS OPKELE_E_CONS_ w
 
-/*
- * @brief the main opkele namespace
- */
 namespace opkele {
     using std::string;
 
     /**
      * the base opkele exception class
      */
diff --git a/include/opkele/extension.h b/include/opkele/extension.h
index f547555..ea0c74c 100644
--- a/include/opkele/extension.h
+++ b/include/opkele/extension.h
@@ -5,15 +5,12 @@
  * @file
  * @brief extensions framework basics
  */
 
 #include <opkele/types.h>
 
-/**
- * @brief the main opkele namespace
- */
 namespace opkele {
 
     /**
      * OpenID extension hooks base class
      */
     class extension_t {
diff --git a/include/opkele/extension_chain.h b/include/opkele/extension_chain.h
index 955f4d5..f0eea94 100644
--- a/include/opkele/extension_chain.h
+++ b/include/opkele/extension_chain.h
@@ -6,15 +6,12 @@
  * @brief extension chain extension
  */
 
 #include <list>
 #include <opkele/extension.h>
 
-/**
- * @brief the main opkele namespace
- */
 namespace opkele {
     using std::list;
 
     /**
      * OpenID extensions chain used to combine extensions, it is actually an
      * stl list of pointers to extensions.
@@ -28,23 +25,14 @@ namespace opkele {
             extension_chain_t() { }
             /**
              * Create extension chain with a single extension in it
              */
             extension_chain_t(extension_t *e) { push_back(e); }
 
-            /**
-             * Implementation of consumer's checkid hook
-             */
             virtual void checkid_hook(params_t& p,const string& identity);
-            /**
-             * Implementation of consumer's id_res hook
-             */
             virtual void id_res_hook(const params_t& p,const params_t& sp,const string& identity);
-            /**
-             * Implementation of server's checkid_hook
-             */
             virtual void checkid_hook(const params_t& pin,params_t& pout);
     };
 
 }
 
 #endif /* __OPKELE_EXTENSION_CHAIN_H */
diff --git a/include/opkele/server.h b/include/opkele/server.h
index 598eb47..e7e5bb3 100644
--- a/include/opkele/server.h
+++ b/include/opkele/server.h
@@ -6,15 +6,12 @@
  * @brief OpenID server-side functionality
  */
 
 #include <opkele/types.h>
 #include <opkele/extension.h>
 
-/**
- * @brief the main opkele namespace
- */
 namespace opkele {
 
     /**
      * implementation of basic server functionality
      */
     class server_t {
diff --git a/include/opkele/sreg.h b/include/opkele/sreg.h
index 6713ef7..df37a86 100644
--- a/include/opkele/sreg.h
+++ b/include/opkele/sreg.h
@@ -5,15 +5,12 @@
  * @file
  * @brief Simple registration extension
  */
 
 #include <opkele/extension.h>
 
-/**
- * @brief the main opkele namespace
- */
 namespace opkele {
     using std::map;
 
     /**
      * OpenID simple registration extension implementation
      * http://openid.net/specs/openid-simple-registration-extension-1_0.html
diff --git a/include/opkele/types.h b/include/opkele/types.h
index ba06776..757c0af 100644
--- a/include/opkele/types.h
+++ b/include/opkele/types.h
@@ -9,15 +9,12 @@
 #include <ostream>
 #include <vector>
 #include <string>
 #include <map>
 #include <memory>
 
-/**
- * @brief the main opkele namespace
- */
 namespace opkele {
     using std::vector;
     using std::string;
     using std::map;
     using std::ostream;
     using std::auto_ptr;
diff --git a/include/opkele/util.h b/include/opkele/util.h
index 2a7a859..edc1859 100644
--- a/include/opkele/util.h
+++ b/include/opkele/util.h
@@ -8,12 +8,15 @@
 #include <openssl/dh.h>
 
 namespace opkele {
     using std::string;
     using std::vector;
 
+    /**
+     * @brief opkele utils namespace
+     */
     namespace util {
 
         /**
          * Convenience class encapsulating SSL BIGNUM object for the purpose of
          * automatical freeing.
          */
diff --git a/include/opkele/xconsumer.h b/include/opkele/xconsumer.h
index 14a8aaa..42796c0 100644
--- a/include/opkele/xconsumer.h
+++ b/include/opkele/xconsumer.h
@@ -6,15 +6,12 @@
  * @brief OpenID consumer with built-in extension chain
  */
 
 #include <opkele/extension_chain.h>
 #include <opkele/consumer.h>
 
-/**
- * @brief the main opkele namespace
- */
 namespace opkele {
 
     /**
      * Extended OpenID consumer implementation with built in
      * extensions chain.
      */
diff --git a/include/opkele/xserver.h b/include/opkele/xserver.h
index e29bfe6..c645d56 100644
--- a/include/opkele/xserver.h
+++ b/include/opkele/xserver.h
@@ -6,15 +6,12 @@
  * @brief OpenID server with built-in extension chain
  */
 
 #include <opkele/extension_chain.h>
 #include <opkele/server.h>
 
-/**
- * @brief the main opkele namespace
- */
 namespace opkele {
 
     /**
      * Extended OpenID server implementationwith built in
      * extensions chain.
      */