summaryrefslogtreecommitdiffabout
path: root/include
authorMichael Krelin <hacker@klever.net>2008-02-08 21:24:46 (UTC)
committer Michael Krelin <hacker@klever.net>2008-02-08 21:24:46 (UTC)
commit2e93c9940944edab87c29a2a13d60090f15fea86 (patch) (unidiff)
tree06cfab5d2c67f0937039dfe52f252f168441b300 /include
parent6c82575a47283fcd7fdd0cf42b96e90a0888c58c (diff)
downloadlibopkele-2e93c9940944edab87c29a2a13d60090f15fea86.zip
libopkele-2e93c9940944edab87c29a2a13d60090f15fea86.tar.gz
libopkele-2e93c9940944edab87c29a2a13d60090f15fea86.tar.bz2
further doxygenation of basic_OP, extension_t and verify_OP
Signed-off-by: Michael Krelin <hacker@klever.net>
Diffstat (limited to 'include') (more/less context) (ignore whitespace changes)
-rw-r--r--include/opkele/basic_op.h3
-rw-r--r--include/opkele/extension.h8
-rw-r--r--include/opkele/verify_op.h10
3 files changed, 21 insertions, 0 deletions
diff --git a/include/opkele/basic_op.h b/include/opkele/basic_op.h
index a0f0af0..0e3231d 100644
--- a/include/opkele/basic_op.h
+++ b/include/opkele/basic_op.h
@@ -9,4 +9,7 @@ namespace opkele {
9 using std::string; 9 using std::string;
10 10
11 /**
12 * Implementation of basic OP functionality
13 */
11 class basic_OP { 14 class basic_OP {
12 public: 15 public:
diff --git a/include/opkele/extension.h b/include/opkele/extension.h
index 37bcb90..38f61e3 100644
--- a/include/opkele/extension.h
+++ b/include/opkele/extension.h
@@ -45,8 +45,16 @@ namespace opkele {
45 virtual void op_id_res_hook(basic_openid_message& oum); 45 virtual void op_id_res_hook(basic_openid_message& oum);
46 46
47 /**
48 * @name deprecated hooks, used by the deprecated consumer_t and
49 * server_t implementations
50 * @{
51 */
47 virtual void checkid_hook(basic_openid_message& om) OPKELE_DEPRECATE; 52 virtual void checkid_hook(basic_openid_message& om) OPKELE_DEPRECATE;
48 virtual void id_res_hook(const basic_openid_message& om, 53 virtual void id_res_hook(const basic_openid_message& om,
49 const basic_openid_message& sp) OPKELE_DEPRECATE; 54 const basic_openid_message& sp) OPKELE_DEPRECATE;
50 virtual void checkid_hook(const basic_openid_message& inm,basic_openid_message& oum); 55 virtual void checkid_hook(const basic_openid_message& inm,basic_openid_message& oum);
56 /**
57 * @}
58 */
51 59
52 /** 60 /**
diff --git a/include/opkele/verify_op.h b/include/opkele/verify_op.h
index 6c3c386..6b94240 100644
--- a/include/opkele/verify_op.h
+++ b/include/opkele/verify_op.h
@@ -6,7 +6,17 @@
6namespace opkele { 6namespace opkele {
7 7
8 /**
9 * The OP implementation that does discovery verification on RP
10 */
8 class verify_op : public basic_OP { 11 class verify_op : public basic_OP {
9 public: 12 public:
10 13
14 /**
15 * In addition to basic_OP::verify_return_to() functionality this
16 * implementation does the discovery on RP to see if return_to matches
17 * the realm
18 * @throw bad_return_to in case we fail to discover corresponding
19 * service endpoint
20 */
11 void verify_return_to(); 21 void verify_return_to();
12 }; 22 };