a bit of doxygenation for prequeue_RP

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

1 files changed, 8 insertions, 1 deletions

diff --git a/include/opkele/prequeue_rp.h b/include/opkele/prequeue_rp.h
index b98dd5a..68fe03d 100644
--- a/include/opkele/prequeue_rp.h
+++ b/include/opkele/prequeue_rp.h
@@ -3,24 +3,27 @@
 
 #include <string>
 #include <set>
 #include <iterator>
 #include <opkele/basic_rp.h>
 
 namespace opkele {
     using std::string;
     using std::set;
     using std::iterator;
     using std::output_iterator_tag;
 
+    /**
+     * discovery-enabled RP implementation, prequeueing discovered endpoints
+     */
     class prequeue_RP : public basic_RP {
         public:
             /**
              * @name Session persistent store API
              * @{
              */
             /**
              * Called before queueing discovered endpoints. Typically happens
              * while initiating authentication session.
              * @see queue_endpoint()
              * @see end_queueing()
              */
@@ -57,25 +60,29 @@ namespace opkele {
              * implementation doesn't use it.
              * @return the normalized identity
              */
             virtual const string get_normalized_id() const;
             /**
              * @}
              */
 
             /**
              * @name Actions
              * @{
              */
+            /**
+             * In addition to base class implementation it does endpoints
+             * discovery and queueing
+             * @param usi User-suppled identifier
+             */
             void initiate(const string& usi);
-
             /**
              * @}
              */
 
             void verify_OP(const string& OP,
                     const string& claimed_id,const string& identity) const;
     };
 
 }
 
 #endif /* __OPKELE_RP_H */