[farsight2/master] Rename the fs2 doc dir into farsight2-libs

Olivier Crête olivier.crete at collabora.co.uk
Tue Dec 23 15:21:26 PST 2008


---
 docs/libs/Makefile.am                  |    2 +-
 docs/libs/farsight-libs-docs.sgml      |   44 ------
 docs/libs/farsight-libs-sections.txt   |  226 --------------------------------
 docs/libs/farsight-libs.types          |   23 ----
 docs/libs/farsight2-libs-docs.sgml     |   44 ++++++
 docs/libs/farsight2-libs-sections.txt  |  226 ++++++++++++++++++++++++++++++++
 docs/libs/farsight2-libs.types         |   23 ++++
 7 files changed, 294 insertions(+), 294 deletions(-)
 delete mode 100644 docs/libs/farsight-libs-docs.sgml
 delete mode 100644 docs/libs/farsight-libs-overrides.txt
 delete mode 100644 docs/libs/farsight-libs-sections.txt
 delete mode 100644 docs/libs/farsight-libs.types
 create mode 100644 docs/libs/farsight2-libs-docs.sgml
 create mode 100644 docs/libs/farsight2-libs-overrides.txt
 create mode 100644 docs/libs/farsight2-libs-sections.txt
 create mode 100644 docs/libs/farsight2-libs.types

diff --git a/docs/libs/Makefile.am b/docs/libs/Makefile.am
index 0816f27..071cc6a 100644
--- a/docs/libs/Makefile.am
+++ b/docs/libs/Makefile.am
@@ -5,7 +5,7 @@
 
 # The name of the module, e.g. 'glib'.
 #DOC_MODULE=gst-plugins-libs- at GST_MAJORMINOR@
-DOC_MODULE=farsight-libs
+DOC_MODULE=farsight2-libs
 
 # generated basefiles
 basefiles = \
diff --git a/docs/libs/farsight-libs-docs.sgml b/docs/libs/farsight-libs-docs.sgml
deleted file mode 100644
index 7fbf30f..0000000
--- a/docs/libs/farsight-libs-docs.sgml
+++ /dev/null
@@ -1,44 +0,0 @@
-<?xml version="1.0"?>
-<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" 
-               "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
-<book id="index" xmlns:xi="http://www.w3.org/2003/XInclude">
-  <bookinfo>
-    <title>Farsight2 Reference Manual</title>
-  </bookinfo>
-
-  <part>
-    <title>User-oriented classes, interfaces and functions</title>
-    <chapter>
-      <title>Farsight GStreamer Interfaces</title>
-      <xi:include href="xml/fs-conference-iface.xml"/>
-    </chapter>
-    <chapter>
-      <title>Farsight Core Library</title>
-      <xi:include href="xml/fs-participant.xml"/>
-      <xi:include href="xml/fs-session.xml"/>
-      <xi:include href="xml/fs-stream.xml"/>
-      <xi:include href="xml/fs-candidate.xml"/>
-      <xi:include href="xml/fs-codec.xml"/>
-    </chapter>
-    <chapter>
-      <title>Farsight Utility Functions and Objects</title>
-      <xi:include href="xml/fs-element-added-notifier.xml"/>
-    </chapter>
-  </part>
-  <part>
-    <title>Classes used implements Farsight plugins</title>
-    <chapter>
-      <title>Farsight GStreamer Base Implementations</title>
-      <xi:include href="xml/fs-base-conference.xml"/>
-    </chapter>
-    <chapter>
-      <title>Farsight Transmitter objects</title> 
-      <xi:include href="xml/fs-transmitter.xml"/>
-      <xi:include href="xml/fs-stream-transmitter.xml"/>
-    </chapter>
-    <chapter>
-      <title>Farsight Plugins infrastructure</title>
-      <xi:include href="xml/fs-plugin.xml"/>
-    </chapter>
-  </part>
-</book>
diff --git a/docs/libs/farsight-libs-overrides.txt b/docs/libs/farsight-libs-overrides.txt
deleted file mode 100644
index e69de29..0000000
diff --git a/docs/libs/farsight-libs-sections.txt b/docs/libs/farsight-libs-sections.txt
deleted file mode 100644
index ce69c41..0000000
--- a/docs/libs/farsight-libs-sections.txt
+++ /dev/null
@@ -1,226 +0,0 @@
-<SECTION>
-<FILE>fs-participant</FILE>
-<TITLE>FsParticipant</TITLE>
-FsParticipant
-FsParticipantClass
-<SUBSECTION Standard>
-FS_PARTICIPANT
-FS_IS_PARTICIPANT
-FS_TYPE_PARTICIPANT
-fs_participant_get_type
-FS_PARTICIPANT_CLASS
-FS_IS_PARTICIPANT_CLASS
-FS_PARTICIPANT_GET_CLASS
-FS_PARTICIPANT_CAST
-FsParticipantPrivate
-</SECTION>
-
-<SECTION>
-<FILE>fs-stream</FILE>
-<TITLE>FsStream</TITLE>
-FsStream
-FsStreamClass
-FsStreamDirection
-fs_stream_add_remote_candidate
-fs_stream_remote_candidates_added
-fs_stream_select_candidate_pair
-fs_stream_set_remote_codecs
-fs_stream_emit_error
-fs_stream_emit_src_pad_added
-<SUBSECTION Standard>
-FS_STREAM
-FS_IS_STREAM
-FS_TYPE_STREAM
-fs_stream_get_type
-FS_STREAM_CLASS
-FS_IS_STREAM_CLASS
-FS_STREAM_GET_CLASS
-FS_STREAM_CAST
-FsStreamPrivate
-</SECTION>
-
-<SECTION>
-<FILE>fs-session</FILE>
-FsDTMFEvent
-FsDTMFMethod
-<TITLE>FsSession</TITLE>
-FsSession
-FsSessionClass
-fs_session_new_stream
-fs_session_start_telephony_event
-fs_session_stop_telephony_event
-fs_session_set_send_codec
-fs_session_emit_error
-<SUBSECTION Standard>
-FS_SESSION
-FS_IS_SESSION
-FS_TYPE_SESSION
-FS_SESSION_CAST
-fs_session_get_type
-FS_SESSION_CLASS
-FS_IS_SESSION_CLASS
-FS_SESSION_GET_CLASS
-FsSessionPrivate
-</SECTION>
-
-<SECTION>
-<FILE>fs-conference-iface</FILE>
-<TITLE>FsConference</TITLE>
-FsConference
-fs_conference_new_session
-fs_conference_new_participant
-FS_ERROR
-FsError
-<SUBSECTION Standard>
-FS_CONFERENCE
-FS_IS_CONFERENCE
-FS_TYPE_CONFERENCE
-fs_conference_get_type
-FS_CONFERENCE_GET_IFACE
-FsConferenceClass
-fs_error_quark
-</SECTION>
-
-<SECTION>
-<FILE>fs-candidate</FILE>
-<TITLE>FsCandidate</TITLE>
-FsCandidateType
-FsNetworkProtocol
-FsComponentType
-FsCandidate
-fs_candidate_new
-fs_candidate_destroy
-fs_candidate_copy
-fs_candidate_list_destroy
-fs_candidate_list_copy
-fs_candidate_get_by_id
-fs_candidate_are_equal
-<SUBSECTION Standard>
-FS_TYPE_CANDIDATE
-fs_candidate_get_type
-FS_TYPE_CANDIDATE_LIST
-fs_candidate_list_get_type
-</SECTION>
-
-<SECTION>
-<FILE>fs-codec</FILE>
-<TITLE>FsCodec</TITLE>
-FsMediaType
-fs_media_type_to_string
-FsCodec
-FsCodecParameter
-FsCodecPreference
-FS_CODEC_ID_ANY
-FS_CODEC_ID_DISABLE
-fs_codec_new
-fs_codec_destroy
-fs_codec_copy
-fs_codec_list_destroy
-fs_codec_list_copy
-fs_codec_list_from_keyfile
-fs_codec_to_string
-fs_codec_are_equal
-fs_codec_to_gst_caps
-<SUBSECTION Standard>
-FS_TYPE_CODEC
-FS_TYPE_CODEC_LIST
-fs_codec_get_type
-fs_codec_list_get_type
-</SECTION>
-
-<SECTION>
-<FILE>fs-base-conference</FILE>
-<TITLE>FsBaseConference</TITLE>
-FsBaseConference
-FsBaseConferenceClass
-<SUBSECTION Standard>
-FS_BASE_CONFERENCE
-FS_BASE_CONFERENCE_CAST
-FS_BASE_CONFERENCE_CLASS
-FS_BASE_CONFERENCE_GET_CLASS
-FS_TYPE_BASE_CONFERENCE
-fs_base_conference_get_type
-FsBaseConferencePrivate
-</SECTION>
-
-<SECTION>
-<FILE>fs-transmitter</FILE>
-<TITLE>FsTransmitter</TITLE>
-FsTransmitter
-FsTransmitterClass
-fs_transmitter_new
-fs_transmitter_new_stream_transmitter
-fs_transmitter_get_stream_transmitter_type
-<SUBSECTION Standard>
-FS_IS_TRANSMITTER
-FS_IS_TRANSMITTER_CLASS
-FS_TRANSMITTER
-FS_TRANSMITTER_CLASS
-FS_TRANSMITTER_GET_CLASS
-FS_TYPE_TRANSMITTER
-FsTransmitterPrivate
-GST_IS_BASE_TRANSFORM
-GST_IS_BASE_TRANSFORM_CLASS
-FS_TRANSMITTER_CAST
-fs_transmitter_get_type
-</SECTION>
-
-<SECTION>
-<FILE>fs-stream-transmitter</FILE>
-<TITLE>FsStreamTransmitter</TITLE>
-FsStreamTransmitter
-FsStreamTransmitterClass
-fs_stream_transmitter_add_remote_candidate
-fs_stream_transmitter_remote_candidates_added
-fs_stream_transmitter_select_candidate_pair
-fs_stream_transmitter_emit_error
-<SUBSECTION Standard>
-FS_IS_STREAM_TRANSMITTER
-FS_IS_STREAM_TRANSMITTER_CLASS
-FS_STREAM_TRANSMITTER
-FS_STREAM_TRANSMITTER_CLASS
-FS_STREAM_TRANSMITTER_GET_CLASS
-FS_TYPE_STREAM_TRANSMITTER
-FS_STREAM_TRANSMITTER_CAST
-FsStreamTransmitterPrivate
-fs_stream_transmitter_get_type
-</SECTION>
-
-<SECTION>
-<FILE>fs-plugin</FILE>
-<TITLE>FsPlugin</TITLE>
-FsPlugin
-fs_plugin_create_valist
-fs_plugin_create
-FS_INIT_PLUGIN
-<SUBSECTION Standard>
-FsPluginClass
-FS_IS_PLUGIN
-FS_IS_PLUGIN_CLASS
-FS_PLUGIN
-FS_PLUGIN_CLASS
-FS_PLUGIN_GET_CLASS
-FS_TYPE_PLUGIN
-FsPluginPrivate
-fs_plugin_get_type
-</SECTION>
-
-<SECTION>
-<FILE>fs-element-added-notifier</FILE>
-<TITLE>FsElementAddedNotifier</TITLE>
-FsElementAddedNotifier
-fs_element_added_notifier_new
-fs_element_added_notifier_add
-fs_element_added_notifier_remove
-fs_element_added_notifier_set_properties_from_keyfile
-<SUBSECTION Standard>
-FsElementAddedNotifierClass
-FsElementAddedNotifierPrivate
-FS_ELEMENT_ADDED_NOTIFIER
-FS_ELEMENT_ADDED_NOTIFIER_CLASS
-FS_ELEMENT_ADDED_NOTIFIER_GET_CLASS
-FS_IS_ELEMENT_ADDED_NOTIFIER
-FS_IS_ELEMENT_ADDED_NOTIFIER_CLASS
-FS_TYPE_ELEMENT_ADDED_NOTIFIER
-fs_element_added_notifier_get_type
-</SECTION>
diff --git a/docs/libs/farsight-libs.types b/docs/libs/farsight-libs.types
deleted file mode 100644
index e092b68..0000000
--- a/docs/libs/farsight-libs.types
+++ /dev/null
@@ -1,23 +0,0 @@
-% 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 "../../gst-libs/gst/farsight/fs-participant.h"
-#include "../../gst-libs/gst/farsight/fs-session.h"
-#include "../../gst-libs/gst/farsight/fs-stream.h"
-#include "../../gst-libs/gst/farsight/fs-base-conference.h"
-#include "../../gst-libs/gst/farsight/fs-transmitter.h"
-#include "../../gst-libs/gst/farsight/fs-stream-transmitter.h"
-#include "../../gst-libs/gst/farsight/fs-element-added-notifier.h"
-
-fs_participant_get_type
-fs_session_get_type
-fs_stream_get_type
-fs_base_conference_get_type
-fs_transmitter_get_type
-fs_stream_transmitter_get_type
-fs_element_added_notifier_get_type
diff --git a/docs/libs/farsight2-libs-docs.sgml b/docs/libs/farsight2-libs-docs.sgml
new file mode 100644
index 0000000..7fbf30f
--- /dev/null
+++ b/docs/libs/farsight2-libs-docs.sgml
@@ -0,0 +1,44 @@
+<?xml version="1.0"?>
+<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" 
+               "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
+<book id="index" xmlns:xi="http://www.w3.org/2003/XInclude">
+  <bookinfo>
+    <title>Farsight2 Reference Manual</title>
+  </bookinfo>
+
+  <part>
+    <title>User-oriented classes, interfaces and functions</title>
+    <chapter>
+      <title>Farsight GStreamer Interfaces</title>
+      <xi:include href="xml/fs-conference-iface.xml"/>
+    </chapter>
+    <chapter>
+      <title>Farsight Core Library</title>
+      <xi:include href="xml/fs-participant.xml"/>
+      <xi:include href="xml/fs-session.xml"/>
+      <xi:include href="xml/fs-stream.xml"/>
+      <xi:include href="xml/fs-candidate.xml"/>
+      <xi:include href="xml/fs-codec.xml"/>
+    </chapter>
+    <chapter>
+      <title>Farsight Utility Functions and Objects</title>
+      <xi:include href="xml/fs-element-added-notifier.xml"/>
+    </chapter>
+  </part>
+  <part>
+    <title>Classes used implements Farsight plugins</title>
+    <chapter>
+      <title>Farsight GStreamer Base Implementations</title>
+      <xi:include href="xml/fs-base-conference.xml"/>
+    </chapter>
+    <chapter>
+      <title>Farsight Transmitter objects</title> 
+      <xi:include href="xml/fs-transmitter.xml"/>
+      <xi:include href="xml/fs-stream-transmitter.xml"/>
+    </chapter>
+    <chapter>
+      <title>Farsight Plugins infrastructure</title>
+      <xi:include href="xml/fs-plugin.xml"/>
+    </chapter>
+  </part>
+</book>
diff --git a/docs/libs/farsight2-libs-overrides.txt b/docs/libs/farsight2-libs-overrides.txt
new file mode 100644
index 0000000..e69de29
diff --git a/docs/libs/farsight2-libs-sections.txt b/docs/libs/farsight2-libs-sections.txt
new file mode 100644
index 0000000..ce69c41
--- /dev/null
+++ b/docs/libs/farsight2-libs-sections.txt
@@ -0,0 +1,226 @@
+<SECTION>
+<FILE>fs-participant</FILE>
+<TITLE>FsParticipant</TITLE>
+FsParticipant
+FsParticipantClass
+<SUBSECTION Standard>
+FS_PARTICIPANT
+FS_IS_PARTICIPANT
+FS_TYPE_PARTICIPANT
+fs_participant_get_type
+FS_PARTICIPANT_CLASS
+FS_IS_PARTICIPANT_CLASS
+FS_PARTICIPANT_GET_CLASS
+FS_PARTICIPANT_CAST
+FsParticipantPrivate
+</SECTION>
+
+<SECTION>
+<FILE>fs-stream</FILE>
+<TITLE>FsStream</TITLE>
+FsStream
+FsStreamClass
+FsStreamDirection
+fs_stream_add_remote_candidate
+fs_stream_remote_candidates_added
+fs_stream_select_candidate_pair
+fs_stream_set_remote_codecs
+fs_stream_emit_error
+fs_stream_emit_src_pad_added
+<SUBSECTION Standard>
+FS_STREAM
+FS_IS_STREAM
+FS_TYPE_STREAM
+fs_stream_get_type
+FS_STREAM_CLASS
+FS_IS_STREAM_CLASS
+FS_STREAM_GET_CLASS
+FS_STREAM_CAST
+FsStreamPrivate
+</SECTION>
+
+<SECTION>
+<FILE>fs-session</FILE>
+FsDTMFEvent
+FsDTMFMethod
+<TITLE>FsSession</TITLE>
+FsSession
+FsSessionClass
+fs_session_new_stream
+fs_session_start_telephony_event
+fs_session_stop_telephony_event
+fs_session_set_send_codec
+fs_session_emit_error
+<SUBSECTION Standard>
+FS_SESSION
+FS_IS_SESSION
+FS_TYPE_SESSION
+FS_SESSION_CAST
+fs_session_get_type
+FS_SESSION_CLASS
+FS_IS_SESSION_CLASS
+FS_SESSION_GET_CLASS
+FsSessionPrivate
+</SECTION>
+
+<SECTION>
+<FILE>fs-conference-iface</FILE>
+<TITLE>FsConference</TITLE>
+FsConference
+fs_conference_new_session
+fs_conference_new_participant
+FS_ERROR
+FsError
+<SUBSECTION Standard>
+FS_CONFERENCE
+FS_IS_CONFERENCE
+FS_TYPE_CONFERENCE
+fs_conference_get_type
+FS_CONFERENCE_GET_IFACE
+FsConferenceClass
+fs_error_quark
+</SECTION>
+
+<SECTION>
+<FILE>fs-candidate</FILE>
+<TITLE>FsCandidate</TITLE>
+FsCandidateType
+FsNetworkProtocol
+FsComponentType
+FsCandidate
+fs_candidate_new
+fs_candidate_destroy
+fs_candidate_copy
+fs_candidate_list_destroy
+fs_candidate_list_copy
+fs_candidate_get_by_id
+fs_candidate_are_equal
+<SUBSECTION Standard>
+FS_TYPE_CANDIDATE
+fs_candidate_get_type
+FS_TYPE_CANDIDATE_LIST
+fs_candidate_list_get_type
+</SECTION>
+
+<SECTION>
+<FILE>fs-codec</FILE>
+<TITLE>FsCodec</TITLE>
+FsMediaType
+fs_media_type_to_string
+FsCodec
+FsCodecParameter
+FsCodecPreference
+FS_CODEC_ID_ANY
+FS_CODEC_ID_DISABLE
+fs_codec_new
+fs_codec_destroy
+fs_codec_copy
+fs_codec_list_destroy
+fs_codec_list_copy
+fs_codec_list_from_keyfile
+fs_codec_to_string
+fs_codec_are_equal
+fs_codec_to_gst_caps
+<SUBSECTION Standard>
+FS_TYPE_CODEC
+FS_TYPE_CODEC_LIST
+fs_codec_get_type
+fs_codec_list_get_type
+</SECTION>
+
+<SECTION>
+<FILE>fs-base-conference</FILE>
+<TITLE>FsBaseConference</TITLE>
+FsBaseConference
+FsBaseConferenceClass
+<SUBSECTION Standard>
+FS_BASE_CONFERENCE
+FS_BASE_CONFERENCE_CAST
+FS_BASE_CONFERENCE_CLASS
+FS_BASE_CONFERENCE_GET_CLASS
+FS_TYPE_BASE_CONFERENCE
+fs_base_conference_get_type
+FsBaseConferencePrivate
+</SECTION>
+
+<SECTION>
+<FILE>fs-transmitter</FILE>
+<TITLE>FsTransmitter</TITLE>
+FsTransmitter
+FsTransmitterClass
+fs_transmitter_new
+fs_transmitter_new_stream_transmitter
+fs_transmitter_get_stream_transmitter_type
+<SUBSECTION Standard>
+FS_IS_TRANSMITTER
+FS_IS_TRANSMITTER_CLASS
+FS_TRANSMITTER
+FS_TRANSMITTER_CLASS
+FS_TRANSMITTER_GET_CLASS
+FS_TYPE_TRANSMITTER
+FsTransmitterPrivate
+GST_IS_BASE_TRANSFORM
+GST_IS_BASE_TRANSFORM_CLASS
+FS_TRANSMITTER_CAST
+fs_transmitter_get_type
+</SECTION>
+
+<SECTION>
+<FILE>fs-stream-transmitter</FILE>
+<TITLE>FsStreamTransmitter</TITLE>
+FsStreamTransmitter
+FsStreamTransmitterClass
+fs_stream_transmitter_add_remote_candidate
+fs_stream_transmitter_remote_candidates_added
+fs_stream_transmitter_select_candidate_pair
+fs_stream_transmitter_emit_error
+<SUBSECTION Standard>
+FS_IS_STREAM_TRANSMITTER
+FS_IS_STREAM_TRANSMITTER_CLASS
+FS_STREAM_TRANSMITTER
+FS_STREAM_TRANSMITTER_CLASS
+FS_STREAM_TRANSMITTER_GET_CLASS
+FS_TYPE_STREAM_TRANSMITTER
+FS_STREAM_TRANSMITTER_CAST
+FsStreamTransmitterPrivate
+fs_stream_transmitter_get_type
+</SECTION>
+
+<SECTION>
+<FILE>fs-plugin</FILE>
+<TITLE>FsPlugin</TITLE>
+FsPlugin
+fs_plugin_create_valist
+fs_plugin_create
+FS_INIT_PLUGIN
+<SUBSECTION Standard>
+FsPluginClass
+FS_IS_PLUGIN
+FS_IS_PLUGIN_CLASS
+FS_PLUGIN
+FS_PLUGIN_CLASS
+FS_PLUGIN_GET_CLASS
+FS_TYPE_PLUGIN
+FsPluginPrivate
+fs_plugin_get_type
+</SECTION>
+
+<SECTION>
+<FILE>fs-element-added-notifier</FILE>
+<TITLE>FsElementAddedNotifier</TITLE>
+FsElementAddedNotifier
+fs_element_added_notifier_new
+fs_element_added_notifier_add
+fs_element_added_notifier_remove
+fs_element_added_notifier_set_properties_from_keyfile
+<SUBSECTION Standard>
+FsElementAddedNotifierClass
+FsElementAddedNotifierPrivate
+FS_ELEMENT_ADDED_NOTIFIER
+FS_ELEMENT_ADDED_NOTIFIER_CLASS
+FS_ELEMENT_ADDED_NOTIFIER_GET_CLASS
+FS_IS_ELEMENT_ADDED_NOTIFIER
+FS_IS_ELEMENT_ADDED_NOTIFIER_CLASS
+FS_TYPE_ELEMENT_ADDED_NOTIFIER
+fs_element_added_notifier_get_type
+</SECTION>
diff --git a/docs/libs/farsight2-libs.types b/docs/libs/farsight2-libs.types
new file mode 100644
index 0000000..e092b68
--- /dev/null
+++ b/docs/libs/farsight2-libs.types
@@ -0,0 +1,23 @@
+% 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 "../../gst-libs/gst/farsight/fs-participant.h"
+#include "../../gst-libs/gst/farsight/fs-session.h"
+#include "../../gst-libs/gst/farsight/fs-stream.h"
+#include "../../gst-libs/gst/farsight/fs-base-conference.h"
+#include "../../gst-libs/gst/farsight/fs-transmitter.h"
+#include "../../gst-libs/gst/farsight/fs-stream-transmitter.h"
+#include "../../gst-libs/gst/farsight/fs-element-added-notifier.h"
+
+fs_participant_get_type
+fs_session_get_type
+fs_stream_get_type
+fs_base_conference_get_type
+fs_transmitter_get_type
+fs_stream_transmitter_get_type
+fs_element_added_notifier_get_type
-- 
1.5.6.5




More information about the farsight-commits mailing list