summaryrefslogtreecommitdiffabout
path: root/include
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) (unidiff)
treece24f86960a745f6e65eaca44a555ad2da7fcfd3 /include
parent9caa31b962c42cf64ce03893ba616b135de12bbd (diff)
downloadlibopkele-ae41407817c5e360e57e06eba656a38b32093977.zip
libopkele-ae41407817c5e360e57e06eba656a38b32093977.tar.gz
libopkele-ae41407817c5e360e57e06eba656a38b32093977.tar.bz2
doxygen improvements
Diffstat (limited to 'include') (more/less context) (ignore 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 @@
9 * @brief reference implementation of association_t 9 * @brief reference implementation of association_t
10 */ 10 */
11 11
12/**
13 * @brief the main opkele namespace
14 */
15namespace opkele { 12namespace opkele {
16 13
17 /** 14 /**
@@ -58,29 +55,11 @@ namespace opkele {
58 : _server(__server), _handle(__handle), _assoc_type(__assoc_type), 55 : _server(__server), _handle(__handle), _assoc_type(__assoc_type),
59 _secret(__secret), _expires(__expires), _stateless(__stateless) { } 56 _secret(__secret), _expires(__expires), _stateless(__stateless) { }
60 57
61 /**
62 * @overload association_t::server()
63 */
64 virtual string server() const { return _server; } 58 virtual string server() const { return _server; }
65 /**
66 * @overload association_t::handle()
67 */
68 virtual string handle() const { return _handle; } 59 virtual string handle() const { return _handle; }
69 /**
70 * @overload association_t::assoc_type()
71 */
72 virtual string assoc_type() const { return _assoc_type; } 60 virtual string assoc_type() const { return _assoc_type; }
73 /**
74 * @overload association_t::secret()
75 */
76 virtual secret_t secret() const { return _secret; } 61 virtual secret_t secret() const { return _secret; }
77 /**
78 * @overload association_t::expires_in()
79 */
80 virtual int expires_in() const { return _expires-time(0); } 62 virtual int expires_in() const { return _expires-time(0); }
81 /**
82 * @overload association_t::stateless()
83 */
84 virtual bool stateless() const { return _stateless; } 63 virtual bool stateless() const { return _stateless; }
85 }; 64 };
86 65
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 @@
9 * @brief OpenID consumer-side functionality 9 * @brief OpenID consumer-side functionality
10 */ 10 */
11 11
12/**
13 * @brief the main opkele namespace
14 */
15namespace opkele { 12namespace opkele {
16 13
17 /** 14 /**
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 @@
1#ifndef __OPKELE_DATA_H 1#ifndef __OPKELE_DATA_H
2#define __OPKELE_DATA_H 2#define __OPKELE_DATA_H
3 3
4/**
5 * @brief the main opkele namespace
6 */
4namespace opkele { 7namespace opkele {
5 8
9 /**
10 * @brief internal data opkele namespace
11 */
6 namespace data { 12 namespace data {
7 extern const char *_default_p; 13 extern const char *_default_p;
8 extern const char *_default_g; 14 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 @@
53 */ 53 */
54# define OPKELE_E_CONS OPKELE_E_CONS_ w 54# define OPKELE_E_CONS OPKELE_E_CONS_ w
55 55
56/*
57 * @brief the main opkele namespace
58 */
59namespace opkele { 56namespace opkele {
60 using std::string; 57 using std::string;
61 58
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 @@
8 8
9#include <opkele/types.h> 9#include <opkele/types.h>
10 10
11/**
12 * @brief the main opkele namespace
13 */
14namespace opkele { 11namespace opkele {
15 12
16 /** 13 /**
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 @@
9#include <list> 9#include <list>
10#include <opkele/extension.h> 10#include <opkele/extension.h>
11 11
12/**
13 * @brief the main opkele namespace
14 */
15namespace opkele { 12namespace opkele {
16 using std::list; 13 using std::list;
17 14
@@ -31,17 +28,8 @@ namespace opkele {
31 */ 28 */
32 extension_chain_t(extension_t *e) { push_back(e); } 29 extension_chain_t(extension_t *e) { push_back(e); }
33 30
34 /**
35 * Implementation of consumer's checkid hook
36 */
37 virtual void checkid_hook(params_t& p,const string& identity); 31 virtual void checkid_hook(params_t& p,const string& identity);
38 /**
39 * Implementation of consumer's id_res hook
40 */
41 virtual void id_res_hook(const params_t& p,const params_t& sp,const string& identity); 32 virtual void id_res_hook(const params_t& p,const params_t& sp,const string& identity);
42 /**
43 * Implementation of server's checkid_hook
44 */
45 virtual void checkid_hook(const params_t& pin,params_t& pout); 33 virtual void checkid_hook(const params_t& pin,params_t& pout);
46 }; 34 };
47 35
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 @@
9#include <opkele/types.h> 9#include <opkele/types.h>
10#include <opkele/extension.h> 10#include <opkele/extension.h>
11 11
12/**
13 * @brief the main opkele namespace
14 */
15namespace opkele { 12namespace opkele {
16 13
17 /** 14 /**
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 @@
8 8
9#include <opkele/extension.h> 9#include <opkele/extension.h>
10 10
11/**
12 * @brief the main opkele namespace
13 */
14namespace opkele { 11namespace opkele {
15 using std::map; 12 using std::map;
16 13
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 @@
12#include <map> 12#include <map>
13#include <memory> 13#include <memory>
14 14
15/**
16 * @brief the main opkele namespace
17 */
18namespace opkele { 15namespace opkele {
19 using std::vector; 16 using std::vector;
20 using std::string; 17 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 {
11 using std::string; 11 using std::string;
12 using std::vector; 12 using std::vector;
13 13
14 /**
15 * @brief opkele utils namespace
16 */
14 namespace util { 17 namespace util {
15 18
16 /** 19 /**
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 @@
9#include <opkele/extension_chain.h> 9#include <opkele/extension_chain.h>
10#include <opkele/consumer.h> 10#include <opkele/consumer.h>
11 11
12/**
13 * @brief the main opkele namespace
14 */
15namespace opkele { 12namespace opkele {
16 13
17 /** 14 /**
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 @@
9#include <opkele/extension_chain.h> 9#include <opkele/extension_chain.h>
10#include <opkele/server.h> 10#include <opkele/server.h>
11 11
12/**
13 * @brief the main opkele namespace
14 */
15namespace opkele { 12namespace opkele {
16 13
17 /** 14 /**