summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorRob Staudinger <robsta@linux.intel.com>2011-09-09 09:46:04 +0200
committerRob Staudinger <robsta@linux.intel.com>2011-09-09 09:46:04 +0200
commit5100f4c4f1109bcc5a58e2ed5b368f557701a365 (patch)
treefc0e6e6daa43263002fa00978f3f8d660ea706f2 /docs
parent067e7cfe1fba3274f5eb40fe90cf03b21b619fe6 (diff)
docs: Update docs build so it includes all public classes, descriptions still missing.
Diffstat (limited to 'docs')
-rw-r--r--docs/reference/ytstenut/Makefile.am17
-rw-r--r--docs/reference/ytstenut/ytstenut-docs.xml.in31
-rw-r--r--docs/reference/ytstenut/ytstenut-sections.txt214
3 files changed, 39 insertions, 223 deletions
diff --git a/docs/reference/ytstenut/Makefile.am b/docs/reference/ytstenut/Makefile.am
index 3424069..85a537c 100644
--- a/docs/reference/ytstenut/Makefile.am
+++ b/docs/reference/ytstenut/Makefile.am
@@ -55,9 +55,20 @@ EXTRA_HFILES=
# Header files to ignore when scanning. Use base file name, no paths
# e.g. IGNORE_HFILES=gtkdebug.h gtkintl.h
IGNORE_HFILES= \
- yts-marshal.h \
- yts-enum-types.h
-
+ empathy-tp-file.h \
+ yts-enum-types.h \
+ yts-marshal.h \
+ yts-private.h \
+ yts-profile.h \
+ yts-profile-proxy.h \
+ yts-profile-adapter.h \
+ yts-profile-impl.h \
+ yts-vp-playable-proxy.h \
+ yts-vp-player-adapter.h \
+ yts-vp-player-proxy.h \
+ yts-vp-transcript-adapter.h \
+ yts-vp-transcript-proxy.h \
+ $(NULL)
# Images to copy into HTML directory.
# e.g. HTML_IMAGES=$(top_srcdir)/gtk/stock-icons/stock_about_24.png
diff --git a/docs/reference/ytstenut/ytstenut-docs.xml.in b/docs/reference/ytstenut/ytstenut-docs.xml.in
index 0843b00..ecfbf99 100644
--- a/docs/reference/ytstenut/ytstenut-docs.xml.in
+++ b/docs/reference/ytstenut/ytstenut-docs.xml.in
@@ -46,17 +46,36 @@
<chapter id="yts-classes">
<title>Ytstenut Objects</title>
- <xi:include href="xml/yts-types.xml"/>
- <xi:include href="xml/yts-error.xml"/>
+ <xi:include href="xml/yts-capability-status.xml"/>
+ <xi:include href="xml/yts-capability.xml"/>
+ <xi:include href="xml/yts-caps.xml"/>
<xi:include href="xml/yts-client.xml"/>
- <xi:include href="xml/yts-roster.xml"/>
<xi:include href="xml/yts-contact.xml"/>
- <xi:include href="xml/yts-service.xml"/>
+ <xi:include href="xml/yts-debug.xml"/>
+ <xi:include href="xml/yts-error-message.xml"/>
+ <xi:include href="xml/yts-error.xml"/>
+ <xi:include href="xml/yts-event-message.xml"/>
+ <xi:include href="xml/yts-invocation-message.xml"/>
+ <xi:include href="xml/yts-main.xml"/>
+ <xi:include href="xml/yts-message.xml"/>
<xi:include href="xml/yts-metadata-service.xml"/>
- <xi:include href="xml/yts-caps.xml"/>
<xi:include href="xml/yts-metadata.xml"/>
+ <xi:include href="xml/yts-proxy-service.xml"/>
+ <xi:include href="xml/yts-proxy.xml"/>
+ <xi:include href="xml/yts-response-message.xml"/>
+ <xi:include href="xml/yts-roster.xml"/>
+ <xi:include href="xml/yts-service-adapter.xml"/>
+ <xi:include href="xml/yts-service.xml"/>
<xi:include href="xml/yts-status.xml"/>
- <xi:include href="xml/yts-message.xml"/>
+ <xi:include href="xml/yts-types.xml"/>
+ <xi:include href="xml/yts-version.xml"/>
+ <xi:include href="xml/yts-vp-content.xml"/>
+ <xi:include href="xml/yts-vp-playable.xml"/>
+ <xi:include href="xml/yts-vp-player.xml"/>
+ <xi:include href="xml/yts-vp-query.xml"/>
+ <xi:include href="xml/yts-vp-transcript.xml"/>
+ <xi:include href="xml/yts-vp-transfer.xml"/>
+ <xi:include href="xml/yts-vp-transmission.xml"/>
</chapter>
diff --git a/docs/reference/ytstenut/ytstenut-sections.txt b/docs/reference/ytstenut/ytstenut-sections.txt
deleted file mode 100644
index e558beb..0000000
--- a/docs/reference/ytstenut/ytstenut-sections.txt
+++ /dev/null
@@ -1,214 +0,0 @@
-<SECTION>
-<FILE>yts-client</FILE>
-<TITLE>YtsClient</TITLE>
-YtsClient
-YtsClientClass
-yts_client_new
-yts_client_disconnect
-yts_client_connect
-yts_client_set_capabilities
-yts_client_get_roster
-yts_client_emit_error
-yts_client_set_incoming_file_directory
-yts_client_get_incoming_file_directory
-yts_client_get_jid
-yts_client_get_uid
-yts_client_set_status
-<SUBSECTION Standard>
-YTS_CLIENT
-YTS_IS_CLIENT
-YTS_TYPE_CLIENT
-yts_client_get_type
-YTS_CLIENT_CLASS
-YTS_IS_CLIENT_CLASS
-YTS_CLIENT_GET_CLASS
-</SECTION>
-
-<SECTION>
-<FILE>yts-roster</FILE>
-<TITLE>YtsRoster</TITLE>
-YtsRoster
-YtsRosterClass
-yts_roster_get_contacts
-yts_roster_find_contact_by_jid
-yts_roster_find_contact_by_capability
-yts_roster_get_client
-<SUBSECTION Standard>
-YTS_ROSTER
-YTS_IS_ROSTER
-YTS_TYPE_ROSTER
-yts_roster_get_type
-YTS_ROSTER_CLASS
-YTS_IS_ROSTER_CLASS
-YTS_ROSTER_GET_CLASS
-</SECTION>
-
-<SECTION>
-<FILE>yts-status</FILE>
-<TITLE>YtsStatus</TITLE>
-YtsStatus
-YtsStatusClass
-yts_status_new
-<SUBSECTION Standard>
-YTS_STATUS
-YTS_IS_STATUS
-YTS_TYPE_STATUS
-yts_status_get_type
-YTS_STATUS_CLASS
-YTS_IS_STATUS_CLASS
-YTS_STATUS_GET_CLASS
-</SECTION>
-
-<SECTION>
-<FILE>yts-metadata-service</FILE>
-<TITLE>YtsMetadataService</TITLE>
-YtsMetadataService
-YtsMetadataServiceClass
-yts_metadata_service_send_metadata
-<SUBSECTION Standard>
-YTS_METADATA_SERVICE
-YTS_IS_METADATA_SERVICE
-YTS_TYPE_METADATA_SERVICE
-yts_metadata_service_get_type
-YTS_METADATA_SERVICE_CLASS
-YTS_IS_METADATA_SERVICE_CLASS
-YTS_METADATA_SERVICE_GET_CLASS
-</SECTION>
-
-<SECTION>
-<FILE>yts-message</FILE>
-<TITLE>YtsMessage</TITLE>
-YtsMessage
-YtsMessageClass
-yts_message_new
-<SUBSECTION Standard>
-YTS_MESSAGE
-YTS_IS_MESSAGE
-YTS_TYPE_MESSAGE
-yts_message_get_type
-YTS_MESSAGE_CLASS
-YTS_IS_MESSAGE_CLASS
-YTS_MESSAGE_GET_CLASS
-</SECTION>
-
-<SECTION>
-<FILE>yts-metadata</FILE>
-<TITLE>YtsMetadata</TITLE>
-YtsMetadata
-YtsMetadataClass
-yts_metadata_get_attribute
-yts_metadata_add_attribute
-yts_metadata_to_string
-yts_metadata_is_equal
-yts_metadata_get_root_node
-<SUBSECTION Standard>
-YTS_METADATA
-YTS_IS_METADATA
-YTS_TYPE_METADATA
-yts_metadata_get_type
-YTS_METADATA_CLASS
-YTS_IS_METADATA_CLASS
-YTS_METADATA_GET_CLASS
-</SECTION>
-
-<SECTION>
-<FILE>yts-contact</FILE>
-<TITLE>YtsContact</TITLE>
-YtsContact
-YtsContactClass
-yts_contact_get_jid
-yts_contact_get_name
-yts_contact_get_tp_contact
-yts_contact_get_icon
-yts_contact_has_capability
-yts_contact_send_file
-yts_contact_cancel_file
-<SUBSECTION Standard>
-YTS_CONTACT
-YTS_IS_CONTACT
-YTS_TYPE_CONTACT
-yts_contact_get_type
-YTS_CONTACT_CLASS
-YTS_IS_CONTACT_CLASS
-YTS_CONTACT_GET_CLASS
-</SECTION>
-
-<SECTION>
-<FILE>yts-service</FILE>
-<TITLE>YtsService</TITLE>
-YtsService
-YtsServiceClass
-yts_service_get_uid
-yts_service_get_jid
-yts_service_get_client
-<SUBSECTION Standard>
-YTS_SERVICE
-YTS_IS_SERVICE
-YTS_TYPE_SERVICE
-yts_service_get_type
-YTS_SERVICE_CLASS
-YTS_IS_SERVICE_CLASS
-YTS_SERVICE_GET_CLASS
-</SECTION>
-
-<SECTION>
-<FILE>yts-main</FILE>
-yts_init
-yts_get_option_group
-</SECTION>
-
-<SECTION>
-<FILE>yts-caps</FILE>
-YtsCaps
-YTS_CAPS_S_UNDEFINED
-YTS_CAPS_UI_UNDEFINED
-YTS_CAPS_UNDEFINED
-YTS_CAPS_S_AUDIO
-YTS_CAPS_UI_AUDIO
-YTS_CAPS_AUDIO
-YTS_CAPS_S_VIDEO
-YTS_CAPS_UI_VIDEO
-YTS_CAPS_VIDEO
-YTS_CAPS_S_IMAGE
-YTS_CAPS_UI_IMAGE
-YTS_CAPS_IMAGE
-YTS_CAPS_S_HTML
-YTS_CAPS_UI_HTML
-YTS_CAPS_HTML
-YTS_CAPS_S_CONTROL
-YTS_CAPS_UI_CONTROL
-YTS_CAPS_CONTROL
-</SECTION>
-
-<SECTION>
-<FILE>yts-debug</FILE>
-YTS_NOTE
-YTS_TIMESTAMP
-YTS_MARK
-</SECTION>
-
-<SECTION>
-<FILE>yts-version</FILE>
-YTS_MAJOR_VERSION
-YTS_MINOR_VERSION
-YTS_MICRO_VERSION
-YTS_VERSION
-YTS_VERSION_S
-YTS_VERSION_HEX
-YTS_CHECK_VERSION
-</SECTION>
-
-<SECTION>
-<FILE>yts-error</FILE>
-YtsError
-yts_error_get_code
-yts_error_get_atom
-yts_error_new_atom
-</SECTION>
-
-<SECTION>
-<FILE>yts-types</FILE>
-YtsProtocol
-YtsPresence
-</SECTION>
-