summaryrefslogtreecommitdiffabout
path: root/include/opkele
authorMichael Krelin <hacker@klever.net>2007-01-12 15:23:09 (UTC)
committer Michael Krelin <hacker@klever.net>2007-01-12 15:23:09 (UTC)
commitae41407817c5e360e57e06eba656a38b32093977 (patch) (side-by-side diff)
treece24f86960a745f6e65eaca44a555ad2da7fcfd3 /include/opkele
parent9caa31b962c42cf64ce03893ba616b135de12bbd (diff)
downloadlibopkele-ae41407817c5e360e57e06eba656a38b32093977.zip
libopkele-ae41407817c5e360e57e06eba656a38b32093977.tar.gz
libopkele-ae41407817c5e360e57e06eba656a38b32093977.tar.bz2
doxygen improvements
Diffstat (limited to 'include/opkele') (more/less context) (show whitespace changes)
-rw-r--r--include/opkele/association.h21
-rw-r--r--include/opkele/consumer.h3
-rw-r--r--include/opkele/data.h6
-rw-r--r--include/opkele/exception.h3
-rw-r--r--include/opkele/extension.h3
-rw-r--r--include/opkele/extension_chain.h12
-rw-r--r--include/opkele/server.h3
-rw-r--r--include/opkele/sreg.h3
-rw-r--r--include/opkele/types.h3
-rw-r--r--include/opkele/util.h3
-rw-r--r--include/opkele/xconsumer.h3
-rw-r--r--include/opkele/xserver.h3
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
@@ -9,9 +9,6 @@
* @brief reference implementation of association_t
*/
-/**
- * @brief the main opkele namespace
- */
namespace opkele {
/**
@@ -58,29 +55,11 @@ namespace opkele {
: _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; }
};
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
@@ -9,9 +9,6 @@
* @brief OpenID consumer-side functionality
*/
-/**
- * @brief the main opkele namespace
- */
namespace opkele {
/**
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,8 +1,14 @@
#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
@@ -53,9 +53,6 @@
*/
# define OPKELE_E_CONS OPKELE_E_CONS_ w
-/*
- * @brief the main opkele namespace
- */
namespace opkele {
using std::string;
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
@@ -8,9 +8,6 @@
#include <opkele/types.h>
-/**
- * @brief the main opkele namespace
- */
namespace opkele {
/**
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
@@ -9,9 +9,6 @@
#include <list>
#include <opkele/extension.h>
-/**
- * @brief the main opkele namespace
- */
namespace opkele {
using std::list;
@@ -31,17 +28,8 @@ namespace opkele {
*/
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);
};
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
@@ -9,9 +9,6 @@
#include <opkele/types.h>
#include <opkele/extension.h>
-/**
- * @brief the main opkele namespace
- */
namespace opkele {
/**
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
@@ -8,9 +8,6 @@
#include <opkele/extension.h>
-/**
- * @brief the main opkele namespace
- */
namespace opkele {
using std::map;
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
@@ -12,9 +12,6 @@
#include <map>
#include <memory>
-/**
- * @brief the main opkele namespace
- */
namespace opkele {
using std::vector;
using std::string;
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
@@ -11,6 +11,9 @@ namespace opkele {
using std::string;
using std::vector;
+ /**
+ * @brief opkele utils namespace
+ */
namespace util {
/**
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
@@ -9,9 +9,6 @@
#include <opkele/extension_chain.h>
#include <opkele/consumer.h>
-/**
- * @brief the main opkele namespace
- */
namespace opkele {
/**
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
@@ -9,9 +9,6 @@
#include <opkele/extension_chain.h>
#include <opkele/server.h>
-/**
- * @brief the main opkele namespace
- */
namespace opkele {
/**