further doxygenation of basic_OP, extension_t and verify_OP

Signed-off-by: Michael Krelin <hacker@klever.net>

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
@@ -5,12 +5,15 @@
 #include <opkele/types.h>
 #include <opkele/extension.h>
 
 namespace opkele {
     using std::string;
 
+    /**
+     * Implementation of basic OP functionality
+     */
     class basic_OP {
         public:
             /**
              * The request mode for the request being processed
              */
             mode_t mode;
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
@@ -41,16 +41,24 @@ namespace opkele {
             /**
              * hook called by OP before signing the reply to RP
              * @param oum message to be sent to RP
              */
             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
              * of pointer.
              */
             operator extension_t*(void) { return this; }
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
@@ -2,15 +2,25 @@
 #define __OPKELE_VERIFY_OP_H
 
 #include <opkele/basic_op.h>
 
 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();
     };
 
 }
 
 #endif /* __OPKELE_VERIFY_OP_H */