Fix documentation problems

This commit is contained in:
Benjamin Dauvergne 2010-04-19 11:30:35 +00:00
parent 81c35bbe2e
commit 05aad98ec3
8 changed files with 16 additions and 20 deletions

View File

@ -93,7 +93,6 @@ lasso_profile_get_signature_hint
lasso_profile_set_signature_verify_hint
lasso_profile_get_signature_verify_hint
lasso_profile_sso_role_with
LassoProfileSignatureHint
<SUBSECTION Standard>
LASSO_PROFILE
LASSO_IS_PROFILE
@ -1890,7 +1889,6 @@ LASSO_LIB_LOGOUT_REQUEST_GET_CLASS
<FILE>soap_binding_ext_credentials_context</FILE>
<TITLE>LassoSoapBindingExtCredentialsContext</TITLE>
LassoSoapBindingExtCredentialsContext
lasso_soap_binding_ext_credentials_context_new
<SUBSECTION Standard>
LASSO_SOAP_BINDING_EXT_CREDENTIALS_CONTEXT
LASSO_IS_SOAP_BINDING_EXT_CREDENTIALS_CONTEXT
@ -2179,7 +2177,6 @@ LASSO_LIB_AUTHN_REQUEST_GET_CLASS
<FILE>disco_authenticate_session_context</FILE>
<TITLE>LassoDiscoAuthenticateSessionContext</TITLE>
LassoDiscoAuthenticateSessionContext
lasso_disco_authenticate_session_context_new
<SUBSECTION Standard>
LASSO_DISCO_AUTHENTICATE_SESSION_CONTEXT
LASSO_IS_DISCO_AUTHENTICATE_SESSION_CONTEXT
@ -2239,7 +2236,6 @@ LASSO_IS_REDIRECT_REQUEST_GET_CLASS
<FILE>soap_binding_ext_credential</FILE>
<TITLE>LassoSoapBindingExtCredential</TITLE>
LassoSoapBindingExtCredential
lasso_soap_binding_ext_credential_new
<SUBSECTION Standard>
LASSO_SOAP_BINDING_EXT_CREDENTIAL
LASSO_IS_SOAP_BINDING_EXT_CREDENTIAL
@ -2561,7 +2557,6 @@ LASSO_IS_INTERACTION_REQUEST_GET_CLASS
<FILE>soap_binding_ext_service_instance_update</FILE>
<TITLE>LassoSoapBindingExtServiceInstanceUpdate</TITLE>
LassoSoapBindingExtServiceInstanceUpdate
lasso_soap_binding_ext_service_instance_update_new
<SUBSECTION Standard>
LASSO_SOAP_BINDING_EXT_SERVICE_INSTANCE_UPDATE
LASSO_IS_SOAP_BINDING_EXT_SERVICE_INSTANCE_UPDATE
@ -6135,4 +6130,3 @@ lasso_soap_envelope_sb2_get_redirect_request_url
lasso_soap_envelope_sb2_get_target_identity_header
lasso_soap_envelope_get_sb2_user_interaction_header
</SECTION>

View File

@ -741,7 +741,7 @@ cleanup:
* <listitem><para>
* #LASSO_LOGIN_ERROR_ASSERTION_REPLAY if the assertion has already been used.
* </para></listitem>
* <itemizedlist>
* </itemizedlist>
**/
gint
lasso_login_accept_sso(LassoLogin *login)
@ -1023,7 +1023,7 @@ lasso_login_build_artifact_msg(LassoLogin *login, LassoHttpMethod http_method)
* #LASSO_PARAM_ERROR_BAD_TYPE_OR_NULL_OBJ if login is not a #LassoLogin object,
* </para></listitem>
* <listitem><para>
* #LASSO_PROFILE_ERROR_MISSING_REMOTE_PROVIDERID if not remote provider ID was setup&nbps;- it usually
* #LASSO_PROFILE_ERROR_MISSING_REMOTE_PROVIDERID if not remote provider ID was setup&160;- it usually
* means that lasso_login_init_request() was not called before,
* </para></listitem>
* <listitem><para>
@ -1036,9 +1036,9 @@ lasso_login_build_artifact_msg(LassoLogin *login, LassoHttpMethod http_method)
* </para></listitem>
* <listitem><para>
* #LASSO_PROFILE_ERROR_BUILDING_QUERY_FAILED if the building of the query part of the redirect URL
* or of the body of the POST content failed&nbsp;- it only happens with the #LASSO_HTTP_METHOD_REDIRECT,
* or of the body of the POST content failed&160;- it only happens with the #LASSO_HTTP_METHOD_REDIRECT,
* #LASSO_HTTP_METHOD_POST, #LASSO_HTTP_METHOD_ARTIFACT_GET and
* #LASSO_HTTP_METHOD_ARTIFACT_POST bindings&nbsp;-,
* #LASSO_HTTP_METHOD_ARTIFACT_POST bindings&160;-,
* </para></listitem>
* <listitem><para>
* #LASSO_PROFILE_ERROR_UNKNOWN_PROFILE_URL if the metadata of the remote provider does not contain

View File

@ -27,10 +27,10 @@
* @short_description: Service or identity provider
*
* <para>The #LassoProvider object holds metadata about a provider. Metadata are sorted into descriptors,
* each descriptor being assigned a role. We refer you to <CiteTitle>Liberty Metadata Description
* each descriptor being assigned a role. We refer you to <citetitle>Liberty Metadata Description
* and Discovery
Specification </CiteTitle> and <CiteTitle>Metadata for the OASIS Security Assertion Markup Language
(SAML) V2.0</CiteTitle>.</para>
Specification </citetitle> and <citetitle>Metadata for the OASIS Security Assertion Markup Language
(SAML) V2.0</citetitle>.</para>
<para>Roles are represented by the enumeration #LassoProviderRole, you can access descriptors
content using lasso_provider_get_metadata_list_by_role() and lasso_provider_get_metadata_by_role().
@ -233,8 +233,8 @@ lasso_provider_get_metadata_one_for_role(LassoProvider *provider, LassoProviderR
*
* Extracts the element @name from the provider metadata descriptor.
*
* Return value:(transfer full)(allow-none): the element value, NULL if the element was not found. This
* string must be freed by the caller.
* Return value:(transfer full)(allow-none): the element value, NULL if the element was not found.
* This string must be freed by the caller.
**/
gchar*
lasso_provider_get_metadata_one(LassoProvider *provider, const char *name)

View File

@ -435,7 +435,7 @@ lasso_idwsf2_profile_check_security_mechanism(LassoIdWsf2Profile *profile,
}
if (! name_qualifier || g_strcmp0(name_qualifier, issuer->ProviderID) != 0)
goto_cleanup_with_rc(LASSO_PROFILE_ERROR_INVALID_ASSERTION);
/** There is two cases for the NameID of the security assertion:
/* There is two cases for the NameID of the security assertion:
* - we are the IdP and the Wsp, so the NameQualifier is us and the SPNameQualifier is the
* Sender
* - we are a simple Wsp, so the NameQualifier is an IdP we know and the

View File

@ -169,7 +169,7 @@ cleanup:
lasso_release_string(response_name);
}
/**
/*
* Apply algorithm for find a default assertion consumer when no declared assertion consumer has the
* isDefault attribute */
static gboolean

View File

@ -714,7 +714,7 @@ lasso_saml2_assertion_get_in_response_to(LassoSaml2Assertion *assertion)
/**
* lasso_saml2_encrypted_element_server_decrypt:
* @encrypted_element:
* @encrypted_element: a #LassoSaml2EncryptedElement object
* @server: a #LassoServer object
* @decrypted_node:(out): an output arg for a #LassoNode
*

View File

@ -1770,7 +1770,7 @@ prefix_from_href_and_nodename(const xmlChar *href, const xmlChar *nodename) {
return prefix;
}
/**
/*
* _type_name_from_href_and_nodename:
* @href: the href part of a QName
* @nodename: the name part of a QName

View File

@ -106,7 +106,9 @@ typedef struct _LassoNodeClass LassoNodeClass;
typedef struct _LassoNodeClassData LassoNodeClassData;
/**
* _LassoNode:
* LassoNode:
*
* Base type for all XML contents, or for object using serialization to XML.
**/
struct _LassoNode {
GObject parent;