diff options
| author | Frederic Peters <fpeters@entrouvert.com> | 2004-12-30 15:12:12 +0000 |
|---|---|---|
| committer | Frederic Peters <fpeters@entrouvert.com> | 2004-12-30 15:12:12 +0000 |
| commit | c338481e24c97f3d3167cd4f688b3c33b849b4e1 (patch) | |
| tree | 4aefd8066d885416bc461b67928f15e608bc5198 | |
| parent | 3a5285a58bcd13b8fb86e82fbc8004d4f00c0037 (diff) | |
| download | lasso-c338481e24c97f3d3167cd4f688b3c33b849b4e1.tar.gz lasso-c338481e24c97f3d3167cd4f688b3c33b849b4e1.tar.xz lasso-c338481e24c97f3d3167cd4f688b3c33b849b4e1.zip | |
documented some new/destroy/dump/... functions
| -rw-r--r-- | lasso/id-ff/lecp.c | 16 | ||||
| -rw-r--r-- | lasso/id-ff/name_registration.c | 26 |
2 files changed, 38 insertions, 4 deletions
diff --git a/lasso/id-ff/lecp.c b/lasso/id-ff/lecp.c index e3dd98ea..2c82174d 100644 --- a/lasso/id-ff/lecp.c +++ b/lasso/id-ff/lecp.c @@ -311,6 +311,13 @@ lasso_lecp_process_authn_response_envelope_msg(LassoLecp *lecp, const char *resp return 0; } +/** + * lasso_lecp_destroy: + * @lecp: a #LassoLecp + * + * Destroys a #LassoLecp object + * + **/ void lasso_lecp_destroy(LassoLecp *lecp) { @@ -378,6 +385,15 @@ lasso_lecp_get_type() return this_type; } +/** + * lasso_lecp_new + * @server: the #LassoServer + * + * Creates a new #LassoLecp. + * + * Return value: a newly created #LassoLecp object; or NULL if an error + * occured + **/ LassoLecp* lasso_lecp_new(LassoServer *server) { diff --git a/lasso/id-ff/name_registration.c b/lasso/id-ff/name_registration.c index a4cb77fa..e3ca3e78 100644 --- a/lasso/id-ff/name_registration.c +++ b/lasso/id-ff/name_registration.c @@ -597,6 +597,15 @@ lasso_name_registration_get_type() return this_type; } +/** + * lasso_name_registration_new: + * @server: the #LassoServer + * + * Creates a new #LassoNameRegistration. + * + * Return value: a newly created #LassoNameRegistration object; or NULL if + * an error occured + **/ LassoNameRegistration * lasso_name_registration_new(LassoServer *server) { @@ -610,6 +619,16 @@ lasso_name_registration_new(LassoServer *server) return name_registration; } +/** + * lasso_name_registration_new_from_dump: + * @server: the #LassoServer + * @dump: XML logout dump + * + * Restores the @dump to a new #LassoNameRegistration. + * + * Return value: a newly created #LassoNameRegistration; or NULL if an error + * occured + **/ LassoNameRegistration* lasso_name_registration_new_from_dump(LassoServer *server, const char *dump) { @@ -625,15 +644,14 @@ lasso_name_registration_new_from_dump(LassoServer *server, const char *dump) /** * lasso_name_registration_dump: - * @name_registration: the register name identifier object + * @name_registration: a #LassoNameRegistration * - * This method builds a dump of the register name identifier object + * Dumps @name_registration content to an XML string. * - * Return value: a newly allocated string or NULL + * Return value: the dump string. It must be freed by the caller. **/ gchar * lasso_name_registration_dump(LassoNameRegistration *name_registration) { return lasso_node_dump(LASSO_NODE(name_registration), NULL, 1); } - |