Documentation: distribute stylesheet, fix documentation comments, compelte lasso-sections.txt

This commit is contained in:
Benjamin Dauvergne 2010-01-18 10:03:54 +00:00
parent ec411327bf
commit 0279087029
15 changed files with 39 additions and 46 deletions

View File

@ -31,5 +31,5 @@ endif
$(REST2HTML) $? > $@
CLEANFILES = $(SP_DOC_HTML) book.html
EXTRA_DIST = lasso-book.txt $(LASSOBOOK_FILES) $(SP_DOC_FILES)
EXTRA_DIST = lasso-book.txt $(LASSOBOOK_FILES) $(SP_DOC_FILES) default.css

View File

@ -1,6 +1,5 @@
<SECTION>
<FILE>server</FILE>
LassoServerPrivate
<TITLE>LassoServer</TITLE>
LassoServer
lasso_server_new
@ -70,12 +69,10 @@ LASSO_NAME_REGISTRATION_GET_CLASS
<SECTION>
<FILE>profile</FILE>
LassoProfilePrivate
LassoRequestType
LassoProfileSignatureHint
<TITLE>LassoProfile</TITLE>
LassoProfile
lasso_profile_get_request_type_from_soap_msg
LassoRequestType
lasso_profile_is_liberty_query
lasso_profile_get_identity
lasso_profile_get_session
@ -90,6 +87,7 @@ lasso_profile_set_artifact_message
lasso_profile_get_server
lasso_profile_set_signature_hint
lasso_profile_get_signature_hint
LassoProfileSignatureHint
<SUBSECTION Standard>
LASSO_PROFILE
LASSO_IS_PROFILE
@ -102,7 +100,6 @@ LASSO_PROFILE_GET_CLASS
<SECTION>
<FILE>identity</FILE>
LassoIdentityPrivate
<TITLE>LassoIdentity</TITLE>
LassoIdentity
lasso_identity_new
@ -122,16 +119,10 @@ LASSO_IDENTITY_GET_CLASS
<SECTION>
<FILE>provider</FILE>
LassoProviderPrivate
LassoHttpMethod
LassoMdProtocolType
LassoProviderRole
LassoProtocolConformance
LassoEncryptionMode
LassoEncryptionSymKeyType
<TITLE>LassoProvider</TITLE>
LassoProvider
lasso_provider_new
LassoProviderRole
lasso_provider_new_from_buffer
lasso_provider_get_assertion_consumer_service_url
lasso_provider_get_metadata_one
@ -139,15 +130,20 @@ lasso_provider_get_metadata_list
lasso_provider_new_from_dump
lasso_provider_get_first_http_method
lasso_provider_accept_http_method
LassoHttpMethod
LassoMdProtocolType
lasso_provider_has_protocol_profile
lasso_provider_get_base64_succinct_id
lasso_provider_get_organization
lasso_provider_get_protocol_conformance
LassoProtocolConformance
lasso_provider_get_encryption_mode
lasso_provider_set_encryption_mode
LassoEncryptionMode
lasso_provider_set_encryption_sym_key_type
LassoEncryptionSymKeyType
lasso_provider_verify_single_node_signature
lasso_provider_get_default_name_id_format
lasso_provider_get_encryption_mode
lasso_provider_get_sp_name_qualifier
<SUBSECTION Standard>
LASSO_PROVIDER
@ -161,7 +157,6 @@ LASSO_PROVIDER_GET_CLASS
<SECTION>
<FILE>session</FILE>
LassoSessionPrivate
<TITLE>LassoSession</TITLE>
LassoSession
lasso_session_new
@ -207,7 +202,6 @@ LASSO_LECP_GET_CLASS
<SECTION>
<FILE>login</FILE>
LassoLoginPrivate
LassoLoginProtocolProfile
<TITLE>LassoLogin</TITLE>
LassoLogin
@ -246,7 +240,6 @@ LASSO_LOGIN_GET_CLASS
<SECTION>
<FILE>federation</FILE>
LassoFederationPrivate
<TITLE>LassoFederation</TITLE>
LassoFederation
lasso_federation_new
@ -265,7 +258,6 @@ LASSO_FEDERATION_GET_CLASS
<SECTION>
<FILE>logout</FILE>
LassoLogoutPrivate
<TITLE>LassoLogout</TITLE>
LassoLogout
lasso_logout_new
@ -314,7 +306,6 @@ LASSO_NAME_IDENTIFIER_MAPPING_GET_CLASS
<SECTION>
<FILE>wsf_profile</FILE>
LassoWsfProfilePrivate
<TITLE>LassoWsfProfile</TITLE>
LassoWsfProfile
lasso_wsf_profile_get_identity
@ -358,7 +349,6 @@ LASSO_WSF_PROFILE_GET_CLASS
<SECTION>
<FILE>authentication</FILE>
LassoAuthenticationPrivate
LassoUserAccount
LassoSaslMechanisms
<TITLE>LassoAuthentication</TITLE>
@ -385,7 +375,6 @@ LASSO_AUTHENTICATION_GET_CLASS
<SECTION>
<FILE>personal_profile_service</FILE>
LassoPersonalProfileServicePrivate
<TITLE>LassoPersonalProfileService</TITLE>
LassoPersonalProfileService
lasso_personal_profile_service_new
@ -403,7 +392,6 @@ LASSO_PERSONAL_PROFILE_SERVICE_GET_CLASS
<SECTION>
<FILE>interaction_profile_service</FILE>
LassoInteractionProfileServicePrivate
<TITLE>LassoInteractionProfileService</TITLE>
LassoInteractionProfileService
lasso_interaction_profile_service_new
@ -422,7 +410,6 @@ LASSO_INTERACTION_PROFILE_SERVICE_GET_CLASS
<SECTION>
<FILE>data_service</FILE>
LassoDataServicePrivate
<TITLE>LassoDataService</TITLE>
LassoDataService
lasso_data_service_new
@ -451,7 +438,6 @@ LASSO_DATA_SERVICE_GET_CLASS
<SECTION>
<FILE>discovery</FILE>
LassoDiscoveryPrivate
<TITLE>LassoDiscovery</TITLE>
LassoDiscovery
lasso_discovery_new
@ -5676,7 +5662,6 @@ LASSO_IDWSF2_DSTREF_DATA_RESPONSE_GET_CLASS
<SECTION>
<FILE>ecp</FILE>
LassoEcpPrivate
<TITLE>LassoEcp</TITLE>
LassoEcp
lasso_ecp_new
@ -5719,7 +5704,6 @@ LASSO_NAME_ID_MANAGEMENT_GET_CLASS
<SECTION>
<FILE>assertion_query</FILE>
LassoAssertionQueryPrivate
LassoAssertionQueryRequestType
<TITLE>LassoAssertionQuery</TITLE>
LassoAssertionQuery
@ -5743,7 +5727,6 @@ LASSO_ASSERTION_QUERY_GET_CLASS
<SECTION>
<FILE>id_wsf_2_0_data_service</FILE>
LassoIdWsf2DataServicePrivate
<TITLE>LassoIdWsf2DataService</TITLE>
LassoIdWsf2DataService
lasso_idwsf2_data_service_new
@ -5763,7 +5746,6 @@ LASSO_IDWSF2_DATA_SERVICE_GET_CLASS
<SECTION>
<FILE>id_wsf_2_0_profile</FILE>
LassoIdWsf2ProfilePrivate
<TITLE>LassoIdWsf2Profile</TITLE>
LassoIdWsf2Profile
lasso_idwsf2_profile_build_request_msg
@ -5781,7 +5763,6 @@ LASSO_IDWSF2_PROFILE_GET_CLASS
<SECTION>
<FILE>id_wsf_2_0_discovery</FILE>
LassoIdWsf2DiscoveryPrivate
<TITLE>LassoIdWsf2Discovery</TITLE>
LassoIdWsf2Discovery
lasso_idwsf2_discovery_new

View File

@ -25,7 +25,7 @@
#ifndef BACKWARD_COMP_H
/** This file contains re-implementations of functions which only exists in recent version of our
/* This file contains re-implementations of functions which only exists in recent version of our
* dependencies, like GLib, OpenSSL or libxml.
*/

View File

@ -1193,7 +1193,14 @@ lasso_wsf_profile_new_full(LassoServer *server, LassoDiscoResourceOffering *offe
return profile;
}
/** Create a new XmlSig template without any reference and return the create
/**
* add_signature_template:
* @server:
* @doc:
* @node
* @signature_ptr:
*
* Create a new XmlSig template without any reference and return the create
* Signature node. If node is not null add Signature as a last child to it.
*/
static gint

View File

@ -69,7 +69,7 @@ HINSTANCE g_hModule = NULL;
* DllMain:
* @hinstDLL: hnadle to the DLL module
* @fdwReason: reason value of the DLL call
* @lpvReserved:
* @lpvReserved: use is unknown.
*
* Called when the DLL is attached or detached by a program.
*

View File

@ -52,7 +52,7 @@ typedef struct _LassoAssertionQueryClass LassoAssertionQueryClass;
typedef struct _LassoAssertionQueryPrivate LassoAssertionQueryPrivate;
/**
* LassoAssertionQueryRequestType::
* LassoAssertionQueryRequestType:
* @LASSO_ASSERTION_QUERY_REQUEST_TYPE_UNSET: the unknown value
* @LASSO_ASSERTION_QUERY_REQUEST_TYPE_ASSERTION_ID: an AssertionID request, to retrieve an
* assertion by its ID.

View File

@ -783,9 +783,10 @@ lasso_saml20_profile_build_soap_request_msg(LassoProfile *profile, const char *u
return 0;
}
/**
/*
* the url parameters is special for this function, it does not give the destination of the message
* (it's implicit for the caller of this function) but where response should be posted later) */
* (it's implicit for the caller of this function) but where response should be posted later).
*/
static int
lasso_profile_saml20_build_paos_request_msg(LassoProfile *profile, const char *url)
{

View File

@ -370,7 +370,7 @@ lasso_is_empty_string(const char *str) {
LASSO_PARAM_ERROR_BAD_TYPE_OR_NULL_OBJ);
/**
/*
* The following macros are made to create some formalism for function's cleanup code.
*
* The exit label should be called 'cleanup'. And for functions returning an integer error code, the

View File

@ -218,10 +218,10 @@ lasso_misc_text_node_new()
/**
* lasso_misc_text_node_new_with_string:
* @content:
* @content: the content of newly created #LassoMiscTextNode
*
* Creates a new #LassoMiscTextNode object and initializes it
* with @content.
* Creates a new #LassoMiscTextNode object and initializes it with @content. Beware that no
* nodename, so it would create a text child, not an element.
*
* Return value: a newly created #LassoMiscTextNode object
**/

View File

@ -125,10 +125,10 @@ lasso_saml2_name_id_new()
/**
* lasso_saml2_name_id_new_with_string:
* @content:
* @content: the Name Identifier.
*
* Creates a new #LassoSaml2NameID object and initializes it
* with @content.
* with @content. Beware that no format is set.
*
* Return value: a newly created #LassoSaml2NameID object
**/

View File

@ -76,6 +76,7 @@ struct _LassoSamlp2AuthnRequest {
/* This field is deprecated do not use it,
* kept for ABI compatibility */
/*< private >*/
G_GNUC_DEPRECATED char *relayState;
};

View File

@ -68,6 +68,7 @@ struct _LassoSamlp2LogoutRequest {
/* This field is deprecated do not use it,
* kept for ABI compatibility */
/*< private >*/
G_GNUC_DEPRECATED char *relayState;
};

View File

@ -55,6 +55,8 @@ struct _LassoSamlp2LogoutResponse {
/* This field is deprecated do not use it,
* kept for ABI compatibility */
/*< private >*/
G_GNUC_DEPRECATED char *relayState;
};

View File

@ -694,7 +694,7 @@ lasso_node_init_from_xml(LassoNode *node, xmlNode *xmlnode)
}
/**
* lasso_node_build_query(LassoNode *node)
* lasso_node_build_query:
* @node: a #LassoNode
*
* Build an HTTP query from the given LassoNode, this is a pure virtual
@ -2718,7 +2718,7 @@ xmlUseNsDef(xmlNs *ns, xmlNode *node)
/**
* xmlCleanNs
* @root_node:
* @root_node: the root #xmlNode where to start the cleaning.
*
* xmlCleanNs removes duplicate xml namespace declarations and merge them on
* the @root_node.

View File

@ -50,7 +50,7 @@ extern "C" {
#define LASSO_NODE_GET_CLASS(o) (G_TYPE_INSTANCE_GET_CLASS ((o), LASSO_TYPE_NODE, LassoNodeClass))
/**
* LassoMessageFormat::
* LassoMessageFormat:
* @LASSO_MESSAGE_FORMAT_ERROR: error while determining format
* @LASSO_MESSAGE_FORMAT_UNKNOWN: unknown format
* @LASSO_MESSAGE_FORMAT_XML: XML
@ -73,7 +73,7 @@ typedef enum {
/**
* LassoSignatureType::
* LassoSignatureType:
* @LASSO_SIGNATURE_TYPE_NONE: no signature
* @LASSO_SIGNATURE_TYPE_SIMPLE: sign with the private key, copy the public part in the signature.
* @LASSO_SIGNATURE_TYPE_WITHX509: sign with the private key, copy the associated certificat in the
@ -89,7 +89,7 @@ typedef enum {
/**
* LassoSignatureMethod::
* LassoSignatureMethod:
* @LASSO_SIGNATURE_METHOD_RSA_SHA1: sign using a RSA private key
* @LASSO_SIGNATURE_METHOD_DSA_SHA1: sign using a DSA private key
*