summaryrefslogtreecommitdiffabout
path: root/include
authorMichael Krelin <hacker@klever.net>2007-01-11 22:34:11 (UTC)
committer Michael Krelin <hacker@klever.net>2007-01-11 22:34:11 (UTC)
commitfc17a506a6647bae8fda0a9943a021a2103f6427 (patch) (side-by-side diff)
tree9a578ee8b43eec5f72ae3f67b973685158d85166 /include
parent6c7179a664044cfbed65ea63b0b4540817eb3408 (diff)
downloadlibopkele-fc17a506a6647bae8fda0a9943a021a2103f6427.zip
libopkele-fc17a506a6647bae8fda0a9943a021a2103f6427.tar.gz
libopkele-fc17a506a6647bae8fda0a9943a021a2103f6427.tar.bz2
doxygen improvements
Diffstat (limited to 'include') (more/less context) (ignore whitespace changes)
-rw-r--r--include/opkele/extension.h11
1 files changed, 9 insertions, 2 deletions
diff --git a/include/opkele/extension.h b/include/opkele/extension.h
index 2248324..f547555 100644
--- a/include/opkele/extension.h
+++ b/include/opkele/extension.h
@@ -21,32 +21,39 @@ namespace opkele {
/**
* hook called by consumer before submitting data to OpenID server.
* It is supposed to manipulate parameters list.
* @param p parameters about to be submitted to server
* @param identity identity being verified. It may differ from the
* one available in parameters list in case of delegation
+ * @see consumer_t::checkid_
+ * @see consumer_t::checkid_immediate
+ * @see consumer_t::checkid_setup
*/
virtual void checkid_hook(params_t& p,const string& identity);
/**
* hook called by consumer after identity information received from
* OpenID server is verified.
* @param p parameters received from server
* @param sp signed parameters received from server with 'openid.'
* leader stripped
* @param identity identity confirmed. May differ from the one
* available in parameters list in case of delegation. May also be
* empty which means - extract one from parameters
+ * @see consumer_t::id_res
*/
virtual void id_res_hook(const params_t& p,const params_t& sp,const string& identity);
/**
* hook called by server before returning information to consumer.
* The hook may manipulate output parameters. It is important to
* note that modified pout["signed"] is used for signing response.
- * @param pin request parameters list
- * @param put response parameters list
+ * @param pin request parameters list with "openid." prefix
+ * @param pout response parameters list without "openid." prefix
+ * @see server_t::checkid_
+ * @see server_t::checkid_immediate
+ * @see server_t::checkid_setup
*/
virtual void checkid_hook(const params_t& pin,params_t& pout);
/**
* Casts the object to pointer to itself. For convenient passing
* of pointer.