diff options
author | Jens Georg <mail@jensge.org> | 2011-04-24 00:19:24 +0300 |
---|---|---|
committer | Zeeshan Ali (Khattak) <zeeshanak@gnome.org> | 2011-06-14 22:42:58 +0300 |
commit | a4eac16e4166d66656d349776ad3d912aed56966 (patch) | |
tree | 146b0e1c9096f9deef8513efa2c1d928c9a8c9f5 | |
parent | 766604c84c4c058f02a02f1b4eb03a2456bd0a2b (diff) | |
download | gupnp-av-a4eac16e4166d66656d349776ad3d912aed56966.tar.gz |
Update introspection annotation
-rw-r--r-- | libgupnp-av/gupnp-didl-lite-container.c | 3 | ||||
-rw-r--r-- | libgupnp-av/gupnp-didl-lite-contributor.c | 4 | ||||
-rw-r--r-- | libgupnp-av/gupnp-didl-lite-descriptor.c | 2 | ||||
-rw-r--r-- | libgupnp-av/gupnp-didl-lite-object.c | 40 | ||||
-rw-r--r-- | libgupnp-av/gupnp-didl-lite-resource.c | 4 | ||||
-rw-r--r-- | libgupnp-av/gupnp-didl-lite-writer.c | 10 | ||||
-rw-r--r-- | libgupnp-av/gupnp-protocol-info.c | 2 |
7 files changed, 35 insertions, 30 deletions
diff --git a/libgupnp-av/gupnp-didl-lite-container.c b/libgupnp-av/gupnp-didl-lite-container.c index b2f190d..ac56d62 100644 --- a/libgupnp-av/gupnp-didl-lite-container.c +++ b/libgupnp-av/gupnp-didl-lite-container.c @@ -201,7 +201,8 @@ gupnp_didl_lite_container_get_child_count (GUPnPDIDLLiteContainer *container) * * Gets the list of create classes of the @object. * - * Return value: The list of create classes belonging to @object, or %NULL. + * Returns: (element-type utf8) (transfer full): The list of create classes + * belonging to @object, or %NULL. * #g_list_free the returned list after usage and #g_free each string in it. **/ GList * diff --git a/libgupnp-av/gupnp-didl-lite-contributor.c b/libgupnp-av/gupnp-didl-lite-contributor.c index f55612a..0c111ff 100644 --- a/libgupnp-av/gupnp-didl-lite-contributor.c +++ b/libgupnp-av/gupnp-didl-lite-contributor.c @@ -346,9 +346,9 @@ gupnp_didl_lite_contributor_new_from_xml (xmlNode *xml_node, * gupnp_didl_lite_contributor_get_xml_node * @contributor: The #GUPnPDIDLLiteContributor * - * Get the pointer to relavent node in XML document. + * Get the pointer to relevant node in XML document. * - * Return value: The pointer to relavent node in XML document. + * Returns: (transfer none): The pointer to relevant node in XML document. **/ xmlNode * gupnp_didl_lite_contributor_get_xml_node (GUPnPDIDLLiteContributor *contributor) diff --git a/libgupnp-av/gupnp-didl-lite-descriptor.c b/libgupnp-av/gupnp-didl-lite-descriptor.c index 9f0b64e..001f5e8 100644 --- a/libgupnp-av/gupnp-didl-lite-descriptor.c +++ b/libgupnp-av/gupnp-didl-lite-descriptor.c @@ -331,7 +331,7 @@ gupnp_didl_lite_descriptor_new_from_xml (xmlNode *xml_node, * * Get the pointer to desc node in XML document. * - * Return value: The pointer to desc node in XML document. + * Returns: (transfer none): The pointer to desc node in XML document. **/ xmlNode * gupnp_didl_lite_descriptor_get_xml_node (GUPnPDIDLLiteDescriptor *descriptor) diff --git a/libgupnp-av/gupnp-didl-lite-object.c b/libgupnp-av/gupnp-didl-lite-object.c index 31778e2..20c833c 100644 --- a/libgupnp-av/gupnp-didl-lite-object.c +++ b/libgupnp-av/gupnp-didl-lite-object.c @@ -860,7 +860,7 @@ gupnp_didl_lite_object_new_from_xml (xmlNode *xml_node, * * Get the pointer to object node in XML document. * - * Return value: The pointer to object node in XML document. + * Returns: (transfer none): The pointer to object node in XML document. **/ xmlNode * gupnp_didl_lite_object_get_xml_node (GUPnPDIDLLiteObject *object) @@ -876,7 +876,7 @@ gupnp_didl_lite_object_get_xml_node (GUPnPDIDLLiteObject *object) * * Get the pointer to the UPnP namespace registered with the XML document. * - * Return value: The pointer to UPnP namespace in XML document. + * Returns: (transfer none): The pointer to UPnP namespace in XML document. **/ xmlNsPtr gupnp_didl_lite_object_get_upnp_namespace (GUPnPDIDLLiteObject *object) @@ -893,7 +893,7 @@ gupnp_didl_lite_object_get_upnp_namespace (GUPnPDIDLLiteObject *object) * Get the pointer to the DublinCore namespace registered with the XML document * containing this object. * - * Return value: The pointer to DublinCore namespace in XML document. + * Returns: (transfer none): The pointer to DublinCore namespace in XML document. **/ xmlNsPtr gupnp_didl_lite_object_get_dc_namespace (GUPnPDIDLLiteObject *object) @@ -927,7 +927,7 @@ gupnp_didl_lite_object_get_upnp_class (GUPnPDIDLLiteObject *object) * Get the pointer to the DLNA metadata namespace registered with the XML * document containing this object. * - * Return value: The pointer to DLNA namespace in XML document. + * Returns: (transfer none): The pointer to DLNA namespace in XML document. **/ xmlNsPtr gupnp_didl_lite_object_get_dlna_namespace (GUPnPDIDLLiteObject *object) @@ -978,9 +978,9 @@ gupnp_didl_lite_object_get_parent_id (GUPnPDIDLLiteObject *object) * * Use this function to retreive property nodes by name. * - * Return value: (element-type utf8) (transfer none): The list of property nodes - * by the name @property_name belonging to @object, or %NULL. #g_list_free the - * returned list after usage but do not modify the contents. + * Return value: (element-type xmlNode*) (transfer container): The list of + * property nodes by the name @property_name belonging to @object, or %NULL. + * #g_list_free the returned list after usage but do not modify the contents. **/ GList * gupnp_didl_lite_object_get_properties (GUPnPDIDLLiteObject *object, @@ -1052,7 +1052,8 @@ gupnp_didl_lite_object_get_creator (GUPnPDIDLLiteObject *object) * * Get the creators of the @object. * - * Return value: The list of creators belonging to @object, or %NULL. + * Returns: (element-type GUPnPDIDLLiteContributor*) (transfer full): The list + * of creators belonging to @object, or %NULL. * #g_list_free the returned list after usage and unref each object in it. **/ GList * @@ -1089,7 +1090,8 @@ gupnp_didl_lite_object_get_artist (GUPnPDIDLLiteObject *object) * * Get the artists of the @object. * - * Return value: The list of artists belonging to @object, or %NULL. + * Returns: (element-type GUPnPDIDLLiteContributor*) (transfer full): The list + * of artists belonging to @object, or %NULL. * #g_list_free the returned list after usage and unref each object in it. **/ GList * @@ -1125,7 +1127,8 @@ gupnp_didl_lite_object_get_author (GUPnPDIDLLiteObject *object) * * Get the authors of the @object. * - * Return value: The list of authors belonging to @object, or %NULL. + * Returns: (element-type GUPnPDIDLLiteContributor*) (transfer full): The list + * of authors belonging to @object, or %NULL. * #g_list_free the returned list after usage and unref each object in it. **/ GList * @@ -1142,7 +1145,8 @@ gupnp_didl_lite_object_get_authors (GUPnPDIDLLiteObject *object) * * Get the descriptors of the @object. * - * Return value: The list of descriptors belonging to @object, or %NULL. + * Returns: (element-type GUPnPDIDLLiteDescriptor*) (transfer full): The list of + * descriptors belonging to @object, or %NULL. * #g_list_free the returned list after usage and unref each object in it. **/ GList * @@ -1333,7 +1337,7 @@ gupnp_didl_lite_object_get_dlna_managed (GUPnPDIDLLiteObject *object) * * Use this function to retreive resources from the @object. * - * Return value: (element-type GUPnPDIDLLiteResource) (transfer full): The list + * Return value: (element-type GUPnPDIDLLiteResource*) (transfer full): The list * of resources belonging to @object, or %NULL. #g_list_free the * returned list after usage and unref each resource in it. **/ @@ -1382,7 +1386,7 @@ gupnp_didl_lite_object_get_resources (GUPnPDIDLLiteObject *object) * If @lenient is #TRUE, the first resource in the list is returned instead of * %NULL if none of resources and protocols are found to be compatible. * - * Return value: The resource belonging to @object that is comaptible with + * Returns: (transfer full): The resource belonging to @object that is comaptible with * any of the protocols specified in @sink_protocol_info, or %NULL. Unref after * usage. **/ @@ -1591,7 +1595,7 @@ gupnp_didl_lite_object_set_creator (GUPnPDIDLLiteObject *object, * Add a new creator node to the @object and return the associated * #GUPnPDIDLLiteContributor object. * - * Return value: A new #GUPnPDIDLLiteContributor object. Unref after usage. + * Returns: (transfer full): A new #GUPnPDIDLLiteContributor object. Unref after usage. **/ GUPnPDIDLLiteContributor * gupnp_didl_lite_object_add_creator (GUPnPDIDLLiteObject *object) @@ -1643,7 +1647,7 @@ gupnp_didl_lite_object_set_artist (GUPnPDIDLLiteObject *object, * Add a new Artist node to the @object and return the associated * #GUPnPDIDLLiteContributor object. * - * Return value: A new #GUPnPDIDLLiteContributor object. Unref after usage. + * Returns: (transfer full): A new #GUPnPDIDLLiteContributor object. Unref after usage. **/ GUPnPDIDLLiteContributor * gupnp_didl_lite_object_add_artist (GUPnPDIDLLiteObject *object) @@ -1694,7 +1698,7 @@ gupnp_didl_lite_object_set_author (GUPnPDIDLLiteObject *object, * Add a new author node to the @object and return the associated * #GUPnPDIDLLiteContributor object. * - * Return value: A new #GUPnPDIDLLiteContributor object. Unref after usage. + * Returns: (transfer full): A new #GUPnPDIDLLiteContributor object. Unref after usage. **/ GUPnPDIDLLiteContributor * gupnp_didl_lite_object_add_author (GUPnPDIDLLiteObject *object) @@ -1916,7 +1920,7 @@ gupnp_didl_lite_object_set_dlna_managed (GUPnPDIDLLiteObject *object, * * Creates a new resource, attaches it to @object and returns it. * - * Return value: A new #GUPnPDIDLLiteResource object. Unref after usage. + * Returns: (transfer full): A new #GUPnPDIDLLiteResource object. Unref after usage. **/ GUPnPDIDLLiteResource * gupnp_didl_lite_object_add_resource (GUPnPDIDLLiteObject *object) @@ -1940,7 +1944,7 @@ gupnp_didl_lite_object_add_resource (GUPnPDIDLLiteObject *object) * * Creates a new descriptor, attaches it to @object and returns it. * - * Return value: A new #GUPnPDIDLLiteDescriptor object. Unref after usage. + * Returns: (transfer full): A new #GUPnPDIDLLiteDescriptor object. Unref after usage. **/ GUPnPDIDLLiteDescriptor * gupnp_didl_lite_object_add_descriptor (GUPnPDIDLLiteObject *object) diff --git a/libgupnp-av/gupnp-didl-lite-resource.c b/libgupnp-av/gupnp-didl-lite-resource.c index d23a52f..fa9a327 100644 --- a/libgupnp-av/gupnp-didl-lite-resource.c +++ b/libgupnp-av/gupnp-didl-lite-resource.c @@ -692,7 +692,7 @@ gupnp_didl_lite_resource_new_from_xml (xmlNode *xml_node, * * Get the pointer to res node in XML document. * - * Return value: The pointer to res node in XML document. + * Returns: (transfer none): The pointer to res node in XML document. **/ xmlNode * gupnp_didl_lite_resource_get_xml_node (GUPnPDIDLLiteResource *resource) @@ -744,7 +744,7 @@ gupnp_didl_lite_resource_get_import_uri (GUPnPDIDLLiteResource *resource) * * Get the protocol info associated with the @resource. * - * Return value: The protocol info associated with the @resource or %NULL. The + * Returns: (transfer none): The protocol info associated with the @resource or %NULL. The * returned object must not be unrefed. **/ GUPnPProtocolInfo * diff --git a/libgupnp-av/gupnp-didl-lite-writer.c b/libgupnp-av/gupnp-didl-lite-writer.c index 54c8447..39e3942 100644 --- a/libgupnp-av/gupnp-didl-lite-writer.c +++ b/libgupnp-av/gupnp-didl-lite-writer.c @@ -435,7 +435,7 @@ gupnp_didl_lite_writer_new (const char *language) * * Creates a new item, attaches it to @writer and returns it. * - * Return value: A new #GUPnPDIDLLiteItem object. Unref after usage. + * Returns: (transfer full): A new #GUPnPDIDLLiteItem object. Unref after usage. **/ GUPnPDIDLLiteItem * gupnp_didl_lite_writer_add_item (GUPnPDIDLLiteWriter *writer) @@ -464,7 +464,7 @@ gupnp_didl_lite_writer_add_item (GUPnPDIDLLiteWriter *writer) * * Creates a new container, attaches it to @writer and returns it. * - * Return value: A new #GUPnPDIDLLiteContainer object. Unref after usage. + * Returns: (transfer full): A new #GUPnPDIDLLiteContainer object. Unref after usage. **/ GUPnPDIDLLiteContainer * gupnp_didl_lite_writer_add_container (GUPnPDIDLLiteWriter *writer) @@ -493,7 +493,7 @@ gupnp_didl_lite_writer_add_container (GUPnPDIDLLiteWriter *writer) * * Creates a new descriptor, attaches it to @object and returns it. * - * Return value: A new #GUPnPDIDLLiteDescriptor object. Unref after usage. + * Returns: (transfer full): A new #GUPnPDIDLLiteDescriptor object. Unref after usage. **/ GUPnPDIDLLiteDescriptor * gupnp_didl_lite_writer_add_descriptor (GUPnPDIDLLiteWriter *writer) @@ -546,7 +546,7 @@ gupnp_didl_lite_writer_get_string (GUPnPDIDLLiteWriter *writer) * * Get the pointer to root node in XML document. * - * Return value: The pointer to root node in XML document. + * Returns: (transfer none): The pointer to root node in XML document. **/ xmlNode * gupnp_didl_lite_writer_get_xml_node (GUPnPDIDLLiteWriter *writer) @@ -562,7 +562,7 @@ gupnp_didl_lite_writer_get_xml_node (GUPnPDIDLLiteWriter *writer) * * Get the language the DIDL-Lite fragment is in. * - * Return value: The language of the @writer, or %NULL. + * Returns: (transfer none): The language of the @writer, or %NULL. **/ const char * gupnp_didl_lite_writer_get_language (GUPnPDIDLLiteWriter *writer) diff --git a/libgupnp-av/gupnp-protocol-info.c b/libgupnp-av/gupnp-protocol-info.c index c63322d..4c0f9e8 100644 --- a/libgupnp-av/gupnp-protocol-info.c +++ b/libgupnp-av/gupnp-protocol-info.c @@ -762,7 +762,7 @@ gupnp_protocol_info_get_dlna_profile (GUPnPProtocolInfo *info) * * Get the allowed play speeds on this info in the form of array of strings. * - * Return value: The allowed play speeds as array of strings or %NULL. This + * Returns: (transfer none): The allowed play speeds as array of strings or %NULL. This * return array and it's content must not be modified or freed. **/ const char ** |