summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorEmanuele Aina <emanuele.aina@collabora.com>2013-08-21 13:37:33 +0200
committerJuan A. Suarez Romero <jasuarez@igalia.com>2013-08-23 22:50:15 +0000
commit18da634b72c5670fb96bbbc4af70a868adb040a2 (patch)
treeac3f2766eb2b2be95051a1c67bac1f3c280e42d9 /doc
parent8bcf9eafafebe18e008ebe7f90ed27764d8331c8 (diff)
downloadgrilo-18da634b72c5670fb96bbbc4af70a868adb040a2.tar.gz
doc: Updates and fixes
- Ignore all the *-priv.h headers - Update grilo-sections.txt with new symbols - Fix referecens to old GrlMediaSource and GrlMetadataSource to point to GrlSource - Standardize element-type annotation to use the C symbol names - Misc cleanups to fix gtk-doc warnings https://bugzilla.gnome.org/show_bug.cgi?id=706487
Diffstat (limited to 'doc')
-rw-r--r--doc/grilo/Makefile.am11
-rw-r--r--doc/grilo/grilo-sections.txt22
-rw-r--r--doc/grilo/plugins-sources.xml15
3 files changed, 36 insertions, 12 deletions
diff --git a/doc/grilo/Makefile.am b/doc/grilo/Makefile.am
index cd0b13c..5055940 100644
--- a/doc/grilo/Makefile.am
+++ b/doc/grilo/Makefile.am
@@ -59,11 +59,16 @@ EXTRA_HFILES=
# Header files to ignore when scanning. Use base file name, no paths
# e.g. IGNORE_HFILES=gtkdebug.h gtkintl.h
IGNORE_HFILES=config.h \
+ grl-log-priv.h \
+ grl-marshal.h \
+ grl-metadata-key-priv.h \
+ grl-metadata-source-priv.h \
+ grl-net-mock-private.h \
+ grl-operation-options-priv.h \
+ grl-operation-priv.h \
grl-plugin-priv.h \
- grl-operations-priv.h \
+ grl-registry-priv.h \
grl-sync-priv.h \
- grl-metadata-key-priv.h \
- grl-marshal.h \
grl-type-builtins.h
# Images to copy into HTML directory.
diff --git a/doc/grilo/grilo-sections.txt b/doc/grilo/grilo-sections.txt
index b795484..7438fc7 100644
--- a/doc/grilo/grilo-sections.txt
+++ b/doc/grilo/grilo-sections.txt
@@ -123,6 +123,7 @@ GrlSourcePrivate
<TITLE>GrlCaps</TITLE>
GrlCaps
GrlCapsClass
+GrlTypeFilter
grl_caps_new
grl_caps_get_key_filter
grl_caps_get_key_range_filter
@@ -150,7 +151,6 @@ GrlCapsPrivate
<TITLE>GrlOperationOptions</TITLE>
GrlOperationOptions
GrlOperationOptionsClass
-GrlOperationCancelCb
grl_operation_options_new
grl_operation_options_copy
grl_operation_options_get_count
@@ -161,7 +161,6 @@ grl_operation_options_get_key_range_filter
grl_operation_options_get_key_range_filter_list
grl_operation_options_get_skip
grl_operation_options_get_type_filter
-grl_operation_options_key_is_set
grl_operation_options_obey_caps
grl_operation_options_set_count
grl_operation_options_set_flags
@@ -242,6 +241,7 @@ grl_related_keys_new_with_keys
grl_related_keys_dup
grl_related_keys_get
grl_related_keys_get_binary
+grl_related_keys_get_boolean
grl_related_keys_get_boxed
grl_related_keys_get_float
grl_related_keys_get_int
@@ -250,10 +250,12 @@ grl_related_keys_get_string
grl_related_keys_has_key
grl_related_keys_set
grl_related_keys_set_binary
+grl_related_keys_set_boolean
grl_related_keys_set_boxed
grl_related_keys_set_float
grl_related_keys_set_int
grl_related_keys_set_string
+grl_related_keys_remove
<SUBSECTION Standard>
GRL_IS_RELATED_KEYS
GRL_IS_RELATED_KEYS_CLASS
@@ -275,6 +277,7 @@ GRL_CONFIG_KEY_APIKEY
GRL_CONFIG_KEY_APIKEY_BLOB
GRL_CONFIG_KEY_APISECRET
GRL_CONFIG_KEY_APITOKEN
+GRL_CONFIG_KEY_APITOKEN_SECRET
GRL_CONFIG_KEY_PASSWORD
GRL_CONFIG_KEY_PLUGIN
GRL_CONFIG_KEY_SOURCE
@@ -284,6 +287,7 @@ grl_config_get_api_key
grl_config_get_api_key_blob
grl_config_get_api_secret
grl_config_get_api_token
+grl_config_get_api_token_secret
grl_config_get_binary
grl_config_get_boolean
grl_config_get_float
@@ -299,6 +303,7 @@ grl_config_set_api_key
grl_config_set_api_key_blob
grl_config_set_api_secret
grl_config_set_api_token
+grl_config_set_api_token_secret
grl_config_set_binary
grl_config_set_boolean
grl_config_set_float
@@ -326,6 +331,7 @@ GrlConfigPrivate
GrlMedia
GrlMediaClass
GrlMediaSerializeType
+GrlMediaType
grl_media_new
grl_media_add_author
grl_media_add_external_player
@@ -341,6 +347,7 @@ grl_media_get_certificate
grl_media_get_creation_date
grl_media_get_description
grl_media_get_duration
+grl_media_get_favourite
grl_media_get_external_url
grl_media_get_external_url_nth
grl_media_get_id
@@ -380,6 +387,7 @@ grl_media_set_description
grl_media_set_duration
grl_media_set_external_player
grl_media_set_external_url
+grl_media_set_favourite
grl_media_set_id
grl_media_set_keyword
grl_media_set_last_played
@@ -426,6 +434,7 @@ grl_data_add_string
grl_data_dup
grl_data_get
grl_data_get_binary
+grl_data_get_boolean
grl_data_get_boxed
grl_data_get_float
grl_data_get_int
@@ -440,6 +449,7 @@ grl_data_remove
grl_data_remove_nth
grl_data_set
grl_data_set_binary
+grl_data_set_boolean
grl_data_set_boxed
grl_data_set_float
grl_data_set_int
@@ -614,11 +624,13 @@ GRL_METADATA_KEY_CERTIFICATE
GRL_METADATA_KEY_CHILDCOUNT
GRL_METADATA_KEY_CREATION_DATE
GRL_METADATA_KEY_DESCRIPTION
+GRL_METADATA_KEY_DIRECTOR
GRL_METADATA_KEY_DURATION
GRL_METADATA_KEY_EPISODE
GRL_METADATA_KEY_EXPOSURE_TIME
GRL_METADATA_KEY_EXTERNAL_PLAYER
GRL_METADATA_KEY_EXTERNAL_URL
+GRL_METADATA_KEY_FAVOURITE
GRL_METADATA_KEY_FLASH_USED
GRL_METADATA_KEY_FRAMERATE
GRL_METADATA_KEY_GENRE
@@ -626,6 +638,7 @@ GRL_METADATA_KEY_HEIGHT
GRL_METADATA_KEY_ID
GRL_METADATA_KEY_INVALID
GRL_METADATA_KEY_ISO_SPEED
+GRL_METADATA_KEY_KEYWORD
GRL_METADATA_KEY_LAST_PLAYED
GRL_METADATA_KEY_LAST_POSITION
GRL_METADATA_KEY_LICENSE
@@ -633,7 +646,10 @@ GRL_METADATA_KEY_LYRICS
GRL_METADATA_KEY_MIME
GRL_METADATA_KEY_MODIFICATION_DATE
GRL_METADATA_KEY_ORIENTATION
+GRL_METADATA_KEY_ORIGINAL_TITLE
+GRL_METADATA_KEY_PERFORMER
GRL_METADATA_KEY_PLAY_COUNT
+GRL_METADATA_KEY_PRODUCER
GRL_METADATA_KEY_PUBLICATION_DATE
GRL_METADATA_KEY_RATING
GRL_METADATA_KEY_REGION
@@ -646,6 +662,7 @@ GRL_METADATA_KEY_STUDIO
GRL_METADATA_KEY_THUMBNAIL
GRL_METADATA_KEY_THUMBNAIL_BINARY
GRL_METADATA_KEY_TITLE
+GRL_METADATA_KEY_TRACK_NUMBER
GRL_METADATA_KEY_URL
GRL_METADATA_KEY_WIDTH
grl_metadata_key_get_desc
@@ -689,6 +706,7 @@ grl_multiple_search_sync
grl_operation_cancel
grl_operation_get_data
grl_operation_set_data
+grl_operation_set_data_full
</SECTION>
<SECTION>
diff --git a/doc/grilo/plugins-sources.xml b/doc/grilo/plugins-sources.xml
index da7d33d..81f09a9 100644
--- a/doc/grilo/plugins-sources.xml
+++ b/doc/grilo/plugins-sources.xml
@@ -1272,7 +1272,8 @@ grl_filesystem_media_from_uri (GrlSource *source,
<para>
Once users have activated notifications by invoking
"notify_change_start", media sources should communicate
- any changes detected by calling grl_media_source_notify_change_list
+ any changes detected by calling <link
+ linkend="grl-source-notify-change-list">grl_source_notify_change_list()</link>
with a list of the media items changed.
</para>
@@ -1312,10 +1313,10 @@ static gboolean
grl_foo_source_notify_change_start (GrlSource *source,
GError **error)
{
- GrlFooMediaSource *foo_source;
+ GrlFooSource *foo_source;
/* Listen to changes in the media content provider */
- foo_source = GRL_FOO_MEDIA_SOURCE (source);
+ foo_source = GRL_FOO_SOURCE (source);
foo_source->listener_id = foo_subscribe_listener_new (content_changed_cb);
return TRUE;
@@ -1325,10 +1326,10 @@ static gboolean
grl_foo_source_notify_change_stop (GrlSource *source,
GError **error)
{
- GrlFooMediaSource *foo_source;
+ GrlFooSource *foo_source;
/* Stop listening to changes in the media content provider */
- foo_source = GRL_FOO_MEDIA_SOURCE (source);
+ foo_source = GRL_FOO_SOURCE (source);
foo_listener_destroy (foo_source->listener_id);
return TRUE;
@@ -1337,9 +1338,9 @@ grl_foo_source_notify_change_stop (GrlSource *source,
</programlisting>
<para>
- Please check the <link linkend="GrlMediaSource">GrlMediaSource</link> API
+ Please check the <link linkend="GrlSource">GrlSource</link> API
reference for more details on how <link
- linkend="grl-media-source-notify-change-list">grl_media_source_notify_change_list()</link>
+ linkend="grl-source-notify-change-list">grl_source_notify_change_list()</link>
should be used.
</para>