diff options
| author | Benjamin Dauvergne <bdauvergne@entrouvert.com> | 2009-03-27 15:04:43 +0000 |
|---|---|---|
| committer | Benjamin Dauvergne <bdauvergne@entrouvert.com> | 2009-03-27 15:04:43 +0000 |
| commit | 01c5740a7b952f8b867289800dcdee287a477f84 (patch) | |
| tree | 99bc347438234f11aecf82e7961014de2b34e61d | |
| parent | 7f09fe60de4f66a35ef751d8dd902066e196860b (diff) | |
Docs: fix doc on Attribute related classes
* xml/saml-2.0/saml2_attribute_value.c:
* xml/saml-2.0/samlp2_extensions.c:
* xml/saml_attribute_value.c:
add documentation about the special way of setting those classes
content, that is using lasso_node_set_original_xmlnode.
* docs/reference/lasso-sections.txt:
* docs/reference/lasso.sgml:
add missing declarations for documentation of LassoSamlAttribute,
LassoSamlAttributeValue, LassoSamlAttributeDesignator,
LassoSamlStatement and LassoSaml2AttributeValue.
| -rw-r--r-- | docs/reference/lasso-sections.txt | 30 | ||||
| -rw-r--r-- | docs/reference/lasso.sgml | 10 | ||||
| -rw-r--r-- | lasso/xml/saml-2.0/saml2_attribute_value.c | 18 | ||||
| -rw-r--r-- | lasso/xml/saml-2.0/samlp2_extensions.c | 5 | ||||
| -rw-r--r-- | lasso/xml/saml_attribute_value.c | 21 |
5 files changed, 80 insertions, 4 deletions
diff --git a/docs/reference/lasso-sections.txt b/docs/reference/lasso-sections.txt index 88c55513..8e380943 100644 --- a/docs/reference/lasso-sections.txt +++ b/docs/reference/lasso-sections.txt @@ -1386,6 +1386,21 @@ LASSO_SAML_ATTRIBUTE_GET_CLASS </SECTION> <SECTION> +<FILE>saml_attribute_value</FILE> +<TITLE>LassoSamlAttributeValue</TITLE> +LassoSamlAttributeValue +lasso_saml_attribute_value_new +<SUBSECTION Standard> +LASSO_SAML_ATTRIBUTE_VALUE +LASSO_IS_SAML_ATTRIBUTE_VALUE +LASSO_TYPE_SAML_ATTRIBUTE_VALUE +lasso_saml_attribute_value_get_type +LASSO_SAML_ATTRIBUTE_VALUE_CLASS +LASSO_IS_SAML_ATTRIBUTE_VALUE_CLASS +LASSO_SAML_ATTRIBUTE_VALUE_GET_CLASS +</SECTION> + +<SECTION> <FILE>saml_attribute_statement</FILE> <TITLE>LassoSamlAttributeStatement</TITLE> LassoSamlAttributeStatement @@ -1584,6 +1599,21 @@ LASSO_SAML2_ATTRIBUTE_GET_CLASS </SECTION> <SECTION> +<FILE>saml2_attribute_value</FILE> +<TITLE>LassoSaml2AttributeValue</TITLE> +LassoSaml2AttributeValue +lasso_saml2_attribute_value_new +<SUBSECTION Standard> +LASSO_SAML2_ATTRIBUTE_VALUE +LASSO_IS_SAML2_ATTRIBUTE_VALUE +LASSO_TYPE_SAML2_ATTRIBUTE_VALUE +lasso_saml2_attribute_value_get_type +LASSO_SAML2_ATTRIBUTE_VALUE_CLASS +LASSO_IS_SAML2_ATTRIBUTE_VALUE_CLASS +LASSO_SAML2_ATTRIBUTE_VALUE_GET_CLASS +</SECTION> + +<SECTION> <FILE>saml2_attribute_statement</FILE> <TITLE>LassoSaml2AttributeStatement</TITLE> LassoSaml2AttributeStatement diff --git a/docs/reference/lasso.sgml b/docs/reference/lasso.sgml index 900edf73..641be345 100644 --- a/docs/reference/lasso.sgml +++ b/docs/reference/lasso.sgml @@ -13,6 +13,10 @@ <!ENTITY LassoLibScoping SYSTEM "sgml/lib_scoping.xml"> <!ENTITY LassoSamlAdvice SYSTEM "sgml/saml_advice.xml"> <!ENTITY LassoSamlAssertion SYSTEM "sgml/saml_assertion.xml"> +<!ENTITY LassoSamlAttribute SYSTEM "sgml/saml_attribute.xml"> +<!ENTITY LassoSamlAttributeDesignator SYSTEM "sgml/saml_attribute_designator.xml"> +<!ENTITY LassoSamlAttributeValue SYSTEM "sgml/saml_attribute_value.xml"> +<!ENTITY LassoSamlAttributeStatement SYSTEM "sgml/saml_attribute_statement.xml"> <!ENTITY LassoSamlAudienceRestrictionCondition SYSTEM "sgml/saml_audience_restriction_condition.xml"> <!ENTITY LassoSamlAuthenticationStatement SYSTEM "sgml/saml_authentication_statement.xml"> <!ENTITY LassoSamlAuthorityBinding SYSTEM "sgml/saml_authority_binding.xml"> @@ -67,6 +71,7 @@ <!ENTITY LassoSaml2Advice SYSTEM "sgml/saml2_advice.xml"> <!ENTITY LassoSaml2Assertion SYSTEM "sgml/saml2_assertion.xml"> <!ENTITY LassoSaml2Attribute SYSTEM "sgml/saml2_attribute.xml"> +<!ENTITY LassoSaml2AttributeValue SYSTEM "sgml/saml2_attribute_value.xml"> <!ENTITY LassoSaml2AttributeStatement SYSTEM "sgml/saml2_attribute_statement.xml"> <!ENTITY LassoSaml2AudienceRestriction SYSTEM "sgml/saml2_audience_restriction.xml"> <!ENTITY LassoSaml2AuthnContext SYSTEM "sgml/saml2_authn_context.xml"> @@ -282,6 +287,10 @@ the <ulink url="http://lasso.entrouvert.org/license">GNU General Public License< &LassoLibSubject; &LassoSamlAdvice; &LassoSamlAssertion; + &LassoSamlAttribute; + &LassoSamlAttributeDesignator; + &LassoSamlAttributeValue; + &LassoSamlAttributeStatement; &LassoSamlAudienceRestrictionCondition; &LassoSamlAuthenticationStatement; &LassoSamlAuthorityBinding; @@ -308,6 +317,7 @@ the <ulink url="http://lasso.entrouvert.org/license">GNU General Public License< &LassoSaml2Advice; &LassoSaml2Assertion; &LassoSaml2Attribute; + &LassoSaml2AttributeValue; &LassoSaml2AttributeStatement; &LassoSaml2AudienceRestriction; &LassoSaml2AuthnContext; diff --git a/lasso/xml/saml-2.0/saml2_attribute_value.c b/lasso/xml/saml-2.0/saml2_attribute_value.c index 8d46f3f8..3fe0941b 100644 --- a/lasso/xml/saml-2.0/saml2_attribute_value.c +++ b/lasso/xml/saml-2.0/saml2_attribute_value.c @@ -23,10 +23,24 @@ #include "../private.h" #include <lasso/xml/saml-2.0/saml2_attribute_value.h> -/* - * The schema fragment (saml-schema-assertion-2.0.xsd): +/** + * SECTION:saml2_attribute_value + * @short_description: value of an attribute in a SAML 2.0 assertion + * @see_also: #LassoSaml2Attribute, #LassoSaml2AttributeStatement, #LassoSaml2Assertion + * + * <figure><title>Schema fragment from saml-schema-assertion-2.0.xsd)</title> + * <programlisting><![CDATA[ * * <element name="AttributeValue" type="anyType" nillable="true"/> + * + * ]]></programlisting> + * </figure> + * + * This object support a special of specifying its content. If the <structfield>any</structfield> + * attribute is %NULL, then you can attach an <type>xmlNode</type> using + * lasso_node_set_original_xmlnode() and it will be used to generate the content of the serialized + * <type>xmlNode</type> for this object. The content (attributes, childrent and namespaces) of the + * node will be copied to the result node created by a call to lasso_node_get_xmlNode(). */ /*****************************************************************************/ diff --git a/lasso/xml/saml-2.0/samlp2_extensions.c b/lasso/xml/saml-2.0/samlp2_extensions.c index 22e44bd5..e7359faf 100644 --- a/lasso/xml/saml-2.0/samlp2_extensions.c +++ b/lasso/xml/saml-2.0/samlp2_extensions.c @@ -39,6 +39,11 @@ * </complexType> * ]]></programlisting> * </figure> + * + * To specify the content of this object you must attach an <type>xmlNode</type> to it using + * lasso_node_set_original_xmlnode(). The content (attributes, children and namespaces) of this node + * will be copied to the result node returned by calls to lasso_node_get_xmlNode(). + * */ /*****************************************************************************/ diff --git a/lasso/xml/saml_attribute_value.c b/lasso/xml/saml_attribute_value.c index ef9ecfaf..ca9fffa5 100644 --- a/lasso/xml/saml_attribute_value.c +++ b/lasso/xml/saml_attribute_value.c @@ -26,9 +26,26 @@ #include "private.h" #include <lasso/xml/saml_attribute_value.h> -/* - * The schema fragment (oasis-sstc-saml-schema-assertion-1.1.xsd): +/** + * SECTION:saml_attribute_value + * @short_description: value of an attribute in SAML 1.0/1.1 assertion + * @see_also: #LassoSamlAttribute, #LassoSamlAttributeStatement, #LassoSamlAssertion + * @include: lasso/xml/saml_attribute_value.h * + * <figure><title>Schema fragment for samlp2:Extensions</title> + * <programlisting><![CDATA[ + * + * <element name="AttributeValue" type="anyType"/> + * + * ]]></programlisting> + * </figure> + * + * This object support a special of specifying its content. If the <structfield>any</structfield> + * field is %NULL, then you can attach an <type>xmlNode</type> using + * lasso_node_set_original_xmlnode() and it will be used to generate the content of the serialized + * <type>xmlNode</type> for this object. The content (attributes, childrent and namespaces) of the + * <type>xmlNode</type> will be copied to the result node returned by calls to + * lasso_node_get_xmlNode(). */ /*****************************************************************************/ |
