From 2e93c9940944edab87c29a2a13d60090f15fea86 Mon Sep 17 00:00:00 2001
From: Michael Krelin <hacker@klever.net>
Date: Fri, 08 Feb 2008 21:24:46 +0000
Subject: further doxygenation of basic_OP, extension_t and verify_OP

Signed-off-by: Michael Krelin <hacker@klever.net>
---
(limited to 'include')

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
@@ -8,6 +8,9 @@
 namespace opkele {
     using std::string;
 
+    /**
+     * Implementation of basic OP functionality
+     */
     class basic_OP {
 	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
@@ -44,10 +44,18 @@ namespace opkele {
 	     */
 	    virtual void op_id_res_hook(basic_openid_message& oum);
 
+	    /**
+	     * @name deprecated hooks, used by the deprecated consumer_t and
+	     * server_t implementations
+	     * @{
+	     */
 	    virtual void checkid_hook(basic_openid_message& om) OPKELE_DEPRECATE;
 	    virtual void id_res_hook(const basic_openid_message& om,
 		    const basic_openid_message& sp) OPKELE_DEPRECATE;
 	    virtual void checkid_hook(const basic_openid_message& inm,basic_openid_message& oum);
+	    /**
+	     * @}
+	     */
 
 	    /**
 	     * Casts the object to pointer to itself. For convenient passing
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
@@ -5,9 +5,19 @@
 
 namespace opkele {
 
+    /**
+     * The OP implementation that does discovery verification on RP
+     */
     class verify_op : public basic_OP {
 	public:
 
+	/**
+	 * In addition to basic_OP::verify_return_to() functionality this
+	 * implementation does the discovery on RP to see if return_to matches
+	 * the realm
+	 * @throw bad_return_to in case we fail to discover corresponding
+	 * service endpoint
+	 */
 	void verify_return_to();
     };
 
--
cgit v0.9.0.2