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
@@ -83,55 +83,60 @@ namespace opkele {
 	     * @param return_to the return_to url to pass with the request
 	     * @param trust_root the trust root to advertise with the request
 	     * @return the location string
 	     * @throw exception in case of error
 	     */
 	    string checkid_immediate(const string& identity,const string& return_to,const string& trust_root="");
 	    /**
 	     * prepare the parameters for the checkid_setup
 	     * request.
 	     * @param identity the identity to verify
 	     * @param return_to the return_to url to pass with the request
 	     * @param trust_root the trust root to advertise with the request
 	     * @return the location string
 	     * @throw exception in case of error
 	     */
 	    string checkid_setup(const string& identity,const string& return_to,const string& trust_root="");
 	    /**
 	     * the actual implementation behind checkid_immediate() and
 	     * checkid_setup() functions.
 	     * @param mode checkid_* mode - either mode_checkid_immediate or mode_checkid_setup
 	     * @param identity the identity to verify
 	     * @param return_to the return_to url to pass with the request
 	     * @param trust_root the trust root to advertise with the request
 	     * @return the location string
 	     * @throw exception in case of error
 	     */
 	    string checkid_(mode_t mode,const string& identity,const string& return_to,const string& trust_root="");
 	    /**
 	     * verify the id_res response
 	     * @param pin the response parameters
 	     * @param identity the identity being checked (if not specified, extracted
 	     * from the openid.identity parameter
 	     * @throw id_res_mismatch in case of signature
 	     * mismatch
 	     * @throw id_res_setup in case of
 	     * openid.user_setup_url failure (supposedly
 	     * checkid_immediate only)
 	     * @throw id_res_failed in case of failure
 	     * @throw exception in case of other failures
 	     */
 	    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 */