diff options
author | Víctor Manuel Jáquez Leal <vjaquez@igalia.com> | 2010-09-29 21:54:46 +0200 |
---|---|---|
committer | Víctor Manuel Jáquez Leal <vjaquez@igalia.com> | 2010-09-30 15:42:57 +0200 |
commit | 2c95e36cece2852085e94b22eb07a33f3fc7dfeb (patch) | |
tree | c0d2ab58b4c095de9957e656ce1255435fa01ed6 | |
parent | 29a06294f3fe1fdc959680e7920b6baa84999e9a (diff) | |
download | grilo-2c95e36cece2852085e94b22eb07a33f3fc7dfeb.tar.gz |
doc: new gtk-doc files
grilo.types defines the GObject types defined in Grilo.
grilo-sections.txt defines the sections and their grouping elements.
Signed-off-by: Víctor Manuel Jáquez Leal <vjaquez@igalia.com>
-rw-r--r-- | doc/reference/grilo-sections.txt | 485 | ||||
-rw-r--r-- | doc/reference/grilo.types | 21 |
2 files changed, 506 insertions, 0 deletions
diff --git a/doc/reference/grilo-sections.txt b/doc/reference/grilo-sections.txt new file mode 100644 index 0000000..8adac7d --- /dev/null +++ b/doc/reference/grilo-sections.txt @@ -0,0 +1,485 @@ +# Grilo API reference sections + +# please add sections in alphabetical order using the following template +# leave two empty lines between sections +# <SECTION> +# <FILE>grl-xxx</FILE> +# <TITLE>GrlXxx</TITLE> +# typedefs +# macros +# constructor +# methods +# <SUBSECTION Standard> +# <SUBSECTION Private> +# </SECTION> + + +<INCLUDE>grilo.h</INCLUDE> + +<SECTION> +<FILE>grl</FILE> +<TITLE>Grl</TITLE> +grl_init +grl_init_get_option_group +grl_paging_translate +grl_list_from_va +</SECTION> + +<SECTION> +<FILE>grl-metadata-source</FILE> +<TITLE>GrlMetadataSource</TITLE> +GrlMetadataSource +GrlMetadataSourceClass +GrlMetadataResolutionFlags +GrlMetadataWritingFlags +GrlMetadataSourceResolveCb +GrlMetadataSourceSetMetadataCb +GrlMetadataSourceResolveSpec +GrlMetadataSourceSetMetadataSpec +GrlSupportedOps +grl_metadata_source_supported_operations +grl_metadata_source_supported_keys +grl_metadata_source_slow_keys +grl_metadata_source_filter_supported +grl_metadata_source_filter_slow +grl_metadata_source_filter_writable +grl_metadata_source_key_depends +grl_metadata_source_writable_keys +grl_metadata_source_resolve +grl_metadata_source_resolve_sync +grl_metadata_source_set_metadata +grl_metadata_source_set_metadata_sync +grl_metadata_source_get_id +grl_metadata_source_get_name +grl_metadata_source_get_description +<SUBSECTION Standard> +GRL_METADATA_SOURCE +GRL_IS_METADATA_SOURCE +GRL_TYPE_METADATA_SOURCE +grl_metadata_source_get_type +GRL_METADATA_SOURCE_CLASS +GRL_IS_METADATA_SOURCE_CLASS +GRL_METADATA_SOURCE_GET_CLASS +<SUBSECTION Private> +GrlMetadataSourcePrivate +</SECTION> + +<SECTION> +<FILE>grl-media-plugin</FILE> +<TITLE>GrlMediaPlugin</TITLE> +GrlMediaPlugin +GrlMediaPluginClass +grl_media_plugin_get_name +grl_media_plugin_get_description +grl_media_plugin_get_version +grl_media_plugin_get_license +grl_media_plugin_get_author +grl_media_plugin_get_site +grl_media_plugin_get_id +grl_media_plugin_get_filename +grl_media_plugin_get_rank +grl_media_plugin_get_info_keys +grl_media_plugin_get_info +<SUBSECTION Standard> +GRL_MEDIA_PLUGIN +GRL_IS_MEDIA_PLUGIN +GRL_TYPE_MEDIA_PLUGIN +grl_media_plugin_get_type +GRL_MEDIA_PLUGIN_CLASS +GRL_IS_MEDIA_PLUGIN_CLASS +GRL_MEDIA_PLUGIN_GET_CLASS +<SUBSECTION Private> +GRL_MEDIA_PLUGIN_NAME +GRL_MEDIA_PLUGIN_DESCRIPTION +GRL_MEDIA_PLUGIN_VERSION +GRL_MEDIA_PLUGIN_LICENSE +GRL_MEDIA_PLUGIN_AUTHOR +GRL_MEDIA_PLUGIN_SITE +GrlMediaPluginPrivate +</SECTION> + +<SECTION> +<FILE>grl-media-source</FILE> +<TITLE>GrlMediaSource</TITLE> +GrlMediaSource +GrlMediaSourceClass +GrlMediaSourceResultCb +GrlMediaSourceMetadataCb +GrlMediaSourceStoreCb +GrlMediaSourceRemoveCb +GrlMediaSourceBrowseSpec +GrlMediaSourceSearchSpec +GrlMediaSourceQuerySpec +GrlMediaSourceMetadataSpec +GrlMediaSourceStoreSpec +GrlMediaSourceRemoveSpec +grl_media_source_browse +grl_media_source_browse_sync +grl_media_source_search +grl_media_source_search_sync +grl_media_source_query +grl_media_source_query_sync +grl_media_source_metadata +grl_media_source_metadata_sync +grl_media_source_store +grl_media_source_store_sync +grl_media_source_remove +grl_media_source_remove_sync +grl_media_source_cancel +grl_media_source_set_operation_data +grl_media_source_get_operation_data +grl_media_source_set_auto_split_threshold +grl_media_source_get_auto_split_threshold +<SUBSECTION Standard> +GRL_MEDIA_SOURCE +GRL_IS_MEDIA_SOURCE +GRL_TYPE_MEDIA_SOURCE +grl_media_source_get_type +GRL_MEDIA_SOURCE_CLASS +GRL_IS_MEDIA_SOURCE_CLASS +GRL_MEDIA_SOURCE_GET_CLASS +<SUBSECTION Private> +GrlMediaSourcePrivate +</SECTION> + +<SECTION> +<FILE>grl-plugin-registry</FILE> +<TITLE>GrlPluginRegistry</TITLE> +GRL_PLUGIN_PATH_VAR +GRL_PLUGIN_RANKS_VAR +GRL_PLUGIN_REGISTER +GrlPluginInfo +GrlPluginDescriptor +GrlPluginRank +GrlPluginRegistry +GrlPluginRegistryClass +grl_plugin_registry_get_default +grl_plugin_registry_add_directory +grl_plugin_registry_load +grl_plugin_registry_load_directory +grl_plugin_registry_unload +grl_plugin_registry_load_all +grl_plugin_registry_register_source +grl_plugin_registry_unregister_source +grl_plugin_registry_lookup_source +grl_plugin_registry_get_sources +grl_plugin_registry_get_sources_by_operations +grl_plugin_registry_register_metadata_key +grl_plugin_registry_lookup_metadata_key +grl_plugin_registry_get_metadata_keys +grl_plugin_registry_add_config +<SUBSECTION Standard> +GRL_PLUGIN_REGISTRY +GRL_IS_PLUGIN_REGISTRY +GRL_TYPE_PLUGIN_REGISTRY +grl_plugin_registry_get_type +GRL_PLUGIN_REGISTRY_CLASS +GRL_IS_PLUGIN_REGISTRY_CLASS +GRL_PLUGIN_REGISTRY_GET_CLASS +<SUBSECTION Private> +GrlPluginRegistryPrivate +</SECTION> + +<SECTION> +<FILE>grl-config</FILE> +<TITLE>GrlConfig</TITLE> +GRL_CONFIG_KEY_PLUGIN +GRL_CONFIG_KEY_SOURCE +GRL_CONFIG_KEY_APIKEY +GRL_CONFIG_KEY_APITOKEN +GRL_CONFIG_KEY_APISECRET +GrlConfig +GrlConfigClass +grl_config_set_plugin +grl_config_set_source +grl_config_set_api_key +grl_config_set_api_token +grl_config_set_api_secret +grl_config_get_plugin +grl_config_get_api_key +grl_config_get_api_token +grl_config_get_api_secret +grl_config_new +grl_config_set +grl_config_set_string +grl_config_set_int +grl_config_set_float +grl_config_get +grl_config_get_string +grl_config_get_int +grl_config_get_float +<SUBSECTION Standard> +GRL_CONFIG +GRL_IS_CONFIG +GRL_TYPE_CONFIG +grl_config_get_type +GRL_CONFIG_CLASS +GRL_IS_CONFIG_CLASS +GRL_CONFIG_GET_CLASS +<SUBSECTION Private> +GrlConfigPrivate +</SECTION> + +<SECTION> +<FILE>grl-media</FILE> +<TITLE>GrlMedia</TITLE> +GrlMediaSerializeType +GrlMedia +GrlMediaClass +grl_media_set_id +grl_media_set_url +grl_media_set_author +grl_media_set_title +grl_media_set_description +grl_media_set_source +grl_media_set_thumbnail +grl_media_set_site +grl_media_set_duration +grl_media_set_date +grl_media_set_mime +grl_media_set_play_count +grl_media_set_last_played +grl_media_set_last_position +grl_media_set_external_player +grl_media_set_external_url +grl_media_set_studio +grl_media_set_certificate +grl_media_set_license +grl_media_set_rating +grl_media_get_id +grl_media_get_url +grl_media_get_author +grl_media_get_title +grl_media_get_description +grl_media_get_source +grl_media_get_thumbnail +grl_media_get_site +grl_media_get_duration +grl_media_get_date +grl_media_get_mime +grl_media_get_rating +grl_media_get_play_count +grl_media_get_last_position +grl_media_get_last_played +grl_media_get_player +grl_media_get_external_url +grl_media_get_studio +grl_media_get_certificate +grl_media_get_license +grl_media_new +grl_media_serialize +grl_media_serialize_extended +grl_media_unserialize +<SUBSECTION Standard> +GRL_MEDIA +GRL_IS_MEDIA +GRL_TYPE_MEDIA +grl_media_get_type +GRL_MEDIA_CLASS +GRL_IS_MEDIA_CLASS +GRL_MEDIA_GET_CLASS +</SECTION> + +<SECTION> +<FILE>grl-data</FILE> +<TITLE>GrlData</TITLE> +GrlData +GrlDataClass +grl_data_new +grl_data_set +grl_data_set_string +grl_data_set_int +grl_data_set_float +grl_data_get +grl_data_get_string +grl_data_get_int +grl_data_get_float +grl_data_add +grl_data_remove +grl_data_has_key +grl_data_get_keys +grl_data_key_is_known +grl_data_set_overwrite +grl_data_get_overwrite +<SUBSECTION Standard> +GRL_DATA +GRL_IS_DATA +GRL_TYPE_DATA +grl_data_get_type +GRL_DATA_CLASS +GRL_IS_DATA_CLASS +GRL_DATA_GET_CLASS +<SUBSECTION Private> +GrlDataPrivate +</SECTION> + +<SECTION> +<FILE>grl-media-box</FILE> +<TITLE>GrlMediaBox</TITLE> +GrlMediaBox +GrlMediaBoxClass +grl_media_box_new +grl_media_box_set_childcount +grl_media_box_get_childcount +<SUBSECTION Standard> +GRL_MEDIA_BOX +GRL_IS_MEDIA_BOX +GRL_TYPE_MEDIA_BOX +grl_media_box_get_type +GRL_MEDIA_BOX_CLASS +GRL_IS_MEDIA_BOX_CLASS +GRL_MEDIA_BOX_GET_CLASS +</SECTION> + +<SECTION> +<FILE>grl-media-video</FILE> +<TITLE>GrlMediaVideo</TITLE> +GrlMediaVideo +GrlMediaVideoClass +grl_media_video_set_width +grl_media_video_set_height +grl_media_video_set_framerate +grl_media_video_get_width +grl_media_video_get_height +grl_media_video_get_framerate +grl_media_video_new +grl_media_video_set_size +<SUBSECTION Standard> +GRL_MEDIA_VIDEO +GRL_IS_MEDIA_VIDEO +GRL_TYPE_MEDIA_VIDEO +grl_media_video_get_type +GRL_MEDIA_VIDEO_CLASS +GRL_IS_MEDIA_VIDEO_CLASS +GRL_MEDIA_VIDEO_GET_CLASS +</SECTION> + +<SECTION> +<FILE>grl-media-audio</FILE> +<TITLE>GrlMediaAudio</TITLE> +GrlMediaAudio +GrlMediaAudioClass +grl_media_audio_set_artist +grl_media_audio_set_album +grl_media_audio_set_genre +grl_media_audio_set_lyrics +grl_media_audio_set_bitrate +grl_media_audio_get_artist +grl_media_audio_get_album +grl_media_audio_get_genre +grl_media_audio_get_lyrics +grl_media_audio_get_bitrate +grl_media_audio_new +<SUBSECTION Standard> +GRL_MEDIA_AUDIO +GRL_IS_MEDIA_AUDIO +GRL_TYPE_MEDIA_AUDIO +grl_media_audio_get_type +GRL_MEDIA_AUDIO_CLASS +GRL_IS_MEDIA_AUDIO_CLASS +GRL_MEDIA_AUDIO_GET_CLASS +</SECTION> + +<SECTION> +<FILE>grl-media-image</FILE> +<TITLE>GrlMediaImage</TITLE> +GrlMediaImage +GrlMediaImageClass +grl_media_image_set_width +grl_media_image_set_height +grl_media_image_get_width +grl_media_image_get_height +grl_media_image_new +grl_media_image_set_size +<SUBSECTION Standard> +GRL_MEDIA_IMAGE +GRL_IS_MEDIA_IMAGE +GRL_TYPE_MEDIA_IMAGE +grl_media_image_get_type +GRL_MEDIA_IMAGE_CLASS +GRL_IS_MEDIA_IMAGE_CLASS +GRL_MEDIA_IMAGE_GET_CLASS +</SECTION> + +<SECTION> +<FILE>grl-metadata-key</FILE> +<TITLE>GrlMetadataKey<TITLE> +GRL_METADATA_KEY_GET_ID +GRL_METADATA_KEY_GET_NAME +GRL_METADATA_KEY_GET_DESC +GRL_METADATA_KEY_GET_TYPE +GRL_METADATA_KEY_CHILDCOUNT_UNKNOWN +GRL_KEYID_FORMAT +grl_metadata_key_list_new +GrlKeyID +GRL_METADATA_KEY_ALBUM +GRL_METADATA_KEY_ARTIST +GRL_METADATA_KEY_AUTHOR +GRL_METADATA_KEY_BITRATE +GRL_METADATA_KEY_CERTIFICATE +GRL_METADATA_KEY_CHILDCOUNT +GRL_METADATA_KEY_DATE +GRL_METADATA_KEY_DESCRIPTION +GRL_METADATA_KEY_DURATION +GRL_METADATA_KEY_EXTERNAL_PLAYER +GRL_METADATA_KEY_EXTERNAL_URL +GRL_METADATA_KEY_FRAMERATE +GRL_METADATA_KEY_GENRE +GRL_METADATA_KEY_HEIGHT +GRL_METADATA_KEY_ID +GRL_METADATA_KEY_LAST_PLAYED +GRL_METADATA_KEY_LAST_POSITION +GRL_METADATA_KEY_LICENSE +GRL_METADATA_KEY_LYRICS +GRL_METADATA_KEY_MIME +GRL_METADATA_KEY_PLAY_COUNT +GRL_METADATA_KEY_RATING +GRL_METADATA_KEY_SITE +GRL_METADATA_KEY_SOURCE +GRL_METADATA_KEY_STUDIO +GRL_METADATA_KEY_THUMBNAIL +GRL_METADATA_KEY_TITLE +GRL_METADATA_KEY_URL +GRL_METADATA_KEY_WIDTH +grl_metadata_key_get_name +grl_metadata_key_get_desc +</SECTION> + +<SECTION> +<FILE>grl-multiple</FILE> +<TITLE>Multiple</TITLE> +grl_multiple_search +grl_multiple_search_sync +grl_multiple_cancel +</SECTION> + +<SECTION> +<FILE>grl-log</FILE> +<TITLE>GrlLog</TITLE> +GrlLogLevel +GRL_LOG_DOMAIN_DEFAULT +GRL_LOG_DOMAIN +GRL_LOG_DOMAIN_EXTERN +GRL_LOG_DOMAIN_STATIC +GRL_LOG_DOMAIN_INIT +GRL_LOG_DOMAIN_FREE +GRL_LOG +GRL_LOG_valist +GRL_ERROR +GRL_WARNING +GRL_MESSAGE +GRL_INFO +GRL_DEBUG +grl_log_domain_new +grl_log_domain_free +grl_log_configure +grl_log +GrlLogDomain +</SECTION> + +<SECTION> +<FILE>grl-error</FILE> +<TITLE>GrlError</TITLE> +GRL_CORE_ERROR +GrlCoreError +</SECTION> diff --git a/doc/reference/grilo.types b/doc/reference/grilo.types new file mode 100644 index 0000000..1a4886d --- /dev/null +++ b/doc/reference/grilo.types @@ -0,0 +1,21 @@ +% add a _get_type for every GObject whose properties and signals you want +% documented +% add the relevant includes to be able to call those _get_type functions + +% adding a get_type here will: +% - change output file name from gstreamer-(whatever).html to (whatever).html +% - document properties and signals + +#include <grilo.h> + +grl_data_get_type +grl_config_get_type +grl_media_get_type +grl_media_box_get_type +grl_media_audio_get_type +grl_media_video_get_type +grl_media_image_get_type +grl_media_plugin_get_type +grl_media_source_get_type +grl_metadata_source_get_type +grl_plugin_registry_get_type |