diff options
author | Jens Georg <mail@jensge.org> | 2012-11-14 23:16:48 +0100 |
---|---|---|
committer | Jens Georg <mail@jensge.org> | 2012-11-19 13:05:08 +0100 |
commit | ff94d599dcd5e45c4e977494225a79cc7ce199ae (patch) | |
tree | bcc392ed0f7099d97880b2a0cf4eb341db2b44fd | |
parent | 1b77e99156d3b0f3372cf021cd5a4f556f4a8343 (diff) | |
download | gupnp-av-ff94d599dcd5e45c4e977494225a79cc7ce199ae.tar.gz |
Doc fixup
-rw-r--r-- | doc/gupnp-av-docs.sgml | 1 | ||||
-rw-r--r-- | doc/gupnp-av-sections.txt | 54 | ||||
-rw-r--r-- | libgupnp-av/gupnp-av-enums.h | 22 | ||||
-rw-r--r-- | libgupnp-av/gupnp-didl-lite-resource.c | 10 | ||||
-rw-r--r-- | libgupnp-av/gupnp-didl-lite-resource.h | 4 | ||||
-rw-r--r-- | libgupnp-av/gupnp-search-criteria-parser.h | 5 |
6 files changed, 89 insertions, 7 deletions
diff --git a/doc/gupnp-av-docs.sgml b/doc/gupnp-av-docs.sgml index 03171be..76f2336 100644 --- a/doc/gupnp-av-docs.sgml +++ b/doc/gupnp-av-docs.sgml @@ -56,6 +56,7 @@ <xi:include href="xml/gupnp-didl-lite-resource.xml"/> <xi:include href="xml/gupnp-didl-lite-descriptor.xml"/> <xi:include href="xml/gupnp-didl-lite-contributor.xml"/> + <xi:include href="xml/gupnp-didl-lite-create-class.xml"/> <xi:include href="xml/gupnp-last-change-parser.xml"/> <xi:include href="xml/gupnp-search-criteria-parser.xml"/> <xi:include href="xml/gupnp-protocol-info.xml"/> diff --git a/doc/gupnp-av-sections.txt b/doc/gupnp-av-sections.txt index c0d46b8..899c739 100644 --- a/doc/gupnp-av-sections.txt +++ b/doc/gupnp-av-sections.txt @@ -3,6 +3,7 @@ <TITLE>GUPnPDIDLLiteObject</TITLE> GUPnPDIDLLiteObject GUPnPOCMFlags +GUPnPDIDLLiteFragmentResult gupnp_didl_lite_object_get_xml_node gupnp_didl_lite_object_get_upnp_namespace gupnp_didl_lite_object_get_dc_namespace @@ -51,8 +52,21 @@ gupnp_didl_lite_object_set_description gupnp_didl_lite_object_set_date gupnp_didl_lite_object_set_track_number gupnp_didl_lite_object_set_dlna_managed +gupnp_didl_lite_object_apply_fragments +gupnp_didl_lite_object_get_album_xml_string +gupnp_didl_lite_object_get_artists_xml_string +gupnp_didl_lite_object_get_date_xml_string +gupnp_didl_lite_object_get_title_xml_string +gupnp_didl_lite_object_get_track_number_xml_string +gupnp_didl_lite_object_get_update_id +gupnp_didl_lite_object_get_upnp_class_xml_string +gupnp_didl_lite_object_set_update_id +gupnp_didl_lite_object_unset_artists +gupnp_didl_lite_object_unset_update_id +gupnp_didl_lite_object_update_id_is_set <SUBSECTION Standard> GUPnPDIDLLiteObjectClass +GUPNP_TYPE_OCM_FLAGS GUPNP_TYPE_DIDL_LITE_OBJECT GUPNP_DIDL_LITE_OBJECT GUPNP_DIDL_LITE_OBJECT_CLASS @@ -62,6 +76,7 @@ GUPNP_DIDL_LITE_OBJECT_GET_CLASS <SUBSECTION Private> GUPnPDIDLLiteObjectPrivate gupnp_didl_lite_object_get_type +gupnp_ocm_flags_get_type </SECTION> <SECTION> @@ -80,6 +95,15 @@ gupnp_didl_lite_container_add_create_class gupnp_didl_lite_container_add_create_class_full gupnp_didl_lite_container_add_search_class gupnp_didl_lite_container_add_search_class_full +gupnp_didl_lite_container_container_update_id_is_set +gupnp_didl_lite_container_get_container_update_id +gupnp_didl_lite_container_get_create_classes_full +gupnp_didl_lite_container_get_total_deleted_child_count +gupnp_didl_lite_container_set_container_update_id +gupnp_didl_lite_container_set_total_deleted_child_count +gupnp_didl_lite_container_total_deleted_child_count_is_set +gupnp_didl_lite_container_unset_container_update_id +gupnp_didl_lite_container_unset_total_deleted_child_count <SUBSECTION Standard> GUPnPDIDLLiteContainerClass GUPNP_TYPE_DIDL_LITE_CONTAINER @@ -192,6 +216,10 @@ gupnp_didl_lite_resource_get_width gupnp_didl_lite_resource_get_height gupnp_didl_lite_resource_get_color_depth gupnp_didl_lite_resource_get_xml_node +gupnp_didl_lite_resource_get_update_count +gupnp_didl_lite_resource_set_update_count +gupnp_didl_lite_resource_unset_update_count +gupnp_didl_lite_resource_update_count_is_set <SUBSECTION Standard> GUPNP_TYPE_DIDL_LITE_RESOURCE GUPNP_DIDL_LITE_RESOURCE @@ -251,6 +279,28 @@ gupnp_didl_lite_contributor_get_type </SECTION> <SECTION> +<FILE>gupnp-didl-lite-create-class</FILE> +<TITLE>GUPnPDIDLLiteCreateClass</TITLE> +gupnp_didl_lite_create_class_get_content +gupnp_didl_lite_create_class_set_content +gupnp_didl_lite_create_class_get_include_derived +gupnp_didl_lite_create_class_set_include_derived +gupnp_didl_lite_create_class_get_friendly_name +gupnp_didl_lite_create_class_set_friendly_name +gupnp_didl_lite_create_class_get_xml_node +<SUBSECTION Standard> +GUPNP_DIDL_LITE_CREATE_CLASS +GUPNP_DIDL_LITE_CREATE_CLASS_CLASS +GUPNP_DIDL_LITE_CREATE_CLASS_GET_CLASS +GUPNP_IS_DIDL_LITE_CREATE_CLASS +GUPNP_IS_DIDL_LITE_CREATE_CLASS_CLASS +GUPNP_TYPE_DIDL_LITE_CREATE_CLASS +<SUBSECTION Private> +GUPnPDIDLLiteCreateClassPrivate +gupnp_didl_lite_create_class_get_type +</SECTION> + +<SECTION> <FILE>gupnp-protocol-info</FILE> <TITLE>GUPnPProtocolInfo</TITLE> GUPnPProtocolInfo @@ -348,6 +398,8 @@ gupnp_feature_get_object_ids GUPnPFeatureClass GUPNP_TYPE_FEATURE GUPNP_FEATURE +GUPNP_IS_FEATURE +GUPNP_IS_FEATURE_CLASS GUPNP_FEATURE_CLASS GUPNP_IS_FEATURE_PARSER GUPNP_IS_FEATURE_PARSER_CLASS @@ -371,6 +423,8 @@ GUPNP_FEATURE_LIST_PARSER_CLASS GUPNP_IS_FEATURE_LIST_PARSER_PARSER GUPNP_IS_FEATURE_LIST_PARSER_PARSER_CLASS GUPNP_FEATURE_LIST_PARSER_GET_CLASS +GUPNP_IS_FEATURE_LIST_PARSER +GUPNP_IS_FEATURE_LIST_PARSER_CLASS <SUBSECTION Private> gupnp_feature_list_parser_get_type </SECTION> diff --git a/libgupnp-av/gupnp-av-enums.h b/libgupnp-av/gupnp-av-enums.h index 701fd14..a230240 100644 --- a/libgupnp-av/gupnp-av-enums.h +++ b/libgupnp-av/gupnp-av-enums.h @@ -26,6 +26,28 @@ G_BEGIN_DECLS +/** + * GUPnPDIDLLiteFragmentResult: + * @GUPNP_DIDL_LITE_FRAGMENT_RESULT_OK: Operation succeeded. + * @GUPNP_DIDL_LITE_FRAGMENT_RESULT_CURRENT_BAD_XML: Current set of fragments + * is bad XML + * @GUPNP_DIDL_LITE_FRAGMENT_RESULT_NEW_BAD_XML: New set of fragments is bad + * XML + * @GUPNP_DIDL_LITE_FRAGMENT_RESULT_CURRENT_INVALID: Current set of fragments + * is invalid + * @GUPNP_DIDL_LITE_FRAGMENT_RESULT_NEW_INVALID: New set of fragments is + * invalid + * @GUPNP_DIDL_LITE_FRAGMENT_RESULT_REQUIRED_TAG: Trying to remove a required + * tag + * @GUPNP_DIDL_LITE_FRAGMENT_RESULT_READONLY_TAG: Trying to modify or remove a + * read-only tag + * @GUPNP_DIDL_LITE_FRAGMENT_RESULT_MISMATCH: Length of the two fragment sets + * does not match + * @GUPNP_DIDL_LITE_FRAGMENT_RESULT_UNKNOWN_ERROR: General error sink if none + * of the others applies. + * + * Possible return values of the gupnp_didl_lite_object_apply_fragments() call. + **/ typedef enum { GUPNP_DIDL_LITE_FRAGMENT_RESULT_OK, GUPNP_DIDL_LITE_FRAGMENT_RESULT_CURRENT_BAD_XML, diff --git a/libgupnp-av/gupnp-didl-lite-resource.c b/libgupnp-av/gupnp-didl-lite-resource.c index 8b4e064..8210b7c 100644 --- a/libgupnp-av/gupnp-didl-lite-resource.c +++ b/libgupnp-av/gupnp-didl-lite-resource.c @@ -822,10 +822,10 @@ gupnp_didl_lite_resource_get_protocol_info (GUPnPDIDLLiteResource *resource) * * Return value: The size (in bytes) of the @resource or -1. **/ -long +glong gupnp_didl_lite_resource_get_size (GUPnPDIDLLiteResource *resource) { - return (long) gupnp_didl_lite_resource_get_size64 (resource); + return (glong) gupnp_didl_lite_resource_get_size64 (resource); } /** @@ -855,7 +855,7 @@ gupnp_didl_lite_resource_get_size64 (GUPnPDIDLLiteResource *resource) * * Return value: The duration (in seconds) of the @resource or -1. **/ -long +glong gupnp_didl_lite_resource_get_duration (GUPnPDIDLLiteResource *resource) { const char *duration_str; @@ -1159,7 +1159,7 @@ gupnp_didl_lite_resource_set_protocol_info (GUPnPDIDLLiteResource *resource, **/ void gupnp_didl_lite_resource_set_size (GUPnPDIDLLiteResource *resource, - long size) + glong size) { gupnp_didl_lite_resource_set_size64 (resource, size); } @@ -1210,7 +1210,7 @@ gupnp_didl_lite_resource_set_size64 (GUPnPDIDLLiteResource *resource, **/ void gupnp_didl_lite_resource_set_duration (GUPnPDIDLLiteResource *resource, - long duration) + glong duration) { g_return_if_fail (GUPNP_IS_DIDL_LITE_RESOURCE (resource)); diff --git a/libgupnp-av/gupnp-didl-lite-resource.h b/libgupnp-av/gupnp-didl-lite-resource.h index cba2e71..2c257b7 100644 --- a/libgupnp-av/gupnp-didl-lite-resource.h +++ b/libgupnp-av/gupnp-didl-lite-resource.h @@ -95,7 +95,7 @@ gupnp_didl_lite_resource_set_protocol_info void gupnp_didl_lite_resource_set_size (GUPnPDIDLLiteResource *resource, - long size); + glong size); void gupnp_didl_lite_resource_set_size64 (GUPnPDIDLLiteResource *resource, @@ -103,7 +103,7 @@ gupnp_didl_lite_resource_set_size64 (GUPnPDIDLLiteResource *resource, void gupnp_didl_lite_resource_set_duration (GUPnPDIDLLiteResource *resource, - long duration); + glong duration); void gupnp_didl_lite_resource_set_bitrate (GUPnPDIDLLiteResource *resource, diff --git a/libgupnp-av/gupnp-search-criteria-parser.h b/libgupnp-av/gupnp-search-criteria-parser.h index ec9fa32..832a17a 100644 --- a/libgupnp-av/gupnp-search-criteria-parser.h +++ b/libgupnp-av/gupnp-search-criteria-parser.h @@ -93,6 +93,11 @@ gupnp_search_criteria_op_get_type (void) G_GNUC_CONST; GQuark gupnp_search_criteria_parser_error_quark (void); +/** + * GUPnPSearchCriteriaParserError: + * @GUPNP_SEARCH_CRITERIA_PARSER_ERROR_FAILED: Parsing the search criteria + * failed. + **/ typedef enum { GUPNP_SEARCH_CRITERIA_PARSER_ERROR_FAILED } GUPnPSearchCriteriaParserError; |