doxygenated canonicalize

1 files changed, 5 insertions, 0 deletions

diff --git a/include/opkele/consumer.h b/include/opkele/consumer.h
index 3c0ed5f..9932315 100644
--- a/include/opkele/consumer.h
+++ b/include/opkele/consumer.h
@@ -123,15 +123,20 @@ namespace opkele {
             void id_res(const params_t& pin,const string& identity="");
             /**
              * perform a check_authentication request.
              * @param server the OpenID server
              * @param p request parameters
              */
             void check_authentication(const string& server,const params_t& p);
 
+            /**
+             * make URL canonical, by adding http:// and trailing slash, if needed.
+             * @param url
+             * @return canonicalized url
+             */
             static string canonicalize(const string& url);
 
     };
 
 }
 
 #endif /* __OPKELE_CONSUMER_H */