[farsight2/master] Generate doc for our gst elements include fs plugins
Olivier Crête
olivier.crete at collabora.co.uk
Tue Dec 23 15:25:19 PST 2008
---
docs/plugins/Makefile.am | 10 ++-
docs/plugins/farsight2-plugins-docs.sgml | 3 +
docs/plugins/farsight2-plugins-sections.txt | 104 +++++++++++++++++++++++----
docs/plugins/farsight2-plugins.types | 3 +
gst/fsrtpconference/Makefile.am | 19 +++++-
5 files changed, 119 insertions(+), 20 deletions(-)
diff --git a/docs/plugins/Makefile.am b/docs/plugins/Makefile.am
index 2179541..274bc9c 100644
--- a/docs/plugins/Makefile.am
+++ b/docs/plugins/Makefile.am
@@ -47,8 +47,8 @@ FIXXREF_OPTIONS=--extra-dir=$(GLIB_PREFIX)/share/gtk-doc/html \
--extra-dir=$(datadir)/gtk-doc/html
# Used for dependencies.
-HFILE_GLOB=$(DOC_SOURCE_DIR)/*/*/*.h
-CFILE_GLOB=$(DOC_SOURCE_DIR)/*/*/*.c
+HFILE_GLOB=$(DOC_SOURCE_DIR)/gst/*/*.h $(DOC_SOURCE_DIR)/transmitters/*/*.h
+CFILE_GLOB=$(DOC_SOURCE_DIR)/gst/*/*.c $(DOC_SOURCE_DIR)/transmitters/*/*.c
# this is a wingo addition
# thomasvs: another nice wingo addition would be an explanation on why
@@ -57,7 +57,7 @@ CFILE_GLOB=$(DOC_SOURCE_DIR)/*/*/*.c
SCANOBJ_DEPS = \
$(top_builddir)/transmitters/multicast/libmulticast-transmitter.la \
$(top_builddir)/transmitters/rawudp/librawudp-transmitter.la \
- $(top_builddir)/gst/fsrtpconference/libfsrtpconference.la \
+ $(top_builddir)/gst/fsrtpconference/libfsrtpconference_doc.la \
$(top_builddir)/gst/funnel/libfsfunnel.la \
$(top_builddir)/gst/videoanyrate/libfsvideoanyrate.la
@@ -77,6 +77,9 @@ EXTRA_HFILES = \
$(top_srcdir)/gst/funnel/fs-funnel.h \
$(top_srcdir)/gst/videoanyrate/videoanyrate.h \
$(top_srcdir)/gst/fsrtpconference/fs-rtp-conference.h \
+ $(top_srcdir)/gst/fsrtpconference/fs-rtp-session.h \
+ $(top_srcdir)/gst/fsrtpconference/fs-rtp-stream.h \
+ $(top_srcdir)/gst/fsrtpconference/fs-rtp-participant.h \
$(top_srcdir)/transmitters/rawudp/fs-rawudp-transmitter.h \
$(top_srcdir)/transmitters/rawudp/fs-rawudp-stream-transmitter.h \
$(top_srcdir)/transmitters/multicast/fs-multicast-transmitter.h \
@@ -96,6 +99,7 @@ extra_files =
GTKDOC_CFLAGS = $(GST_BASE_CFLAGS) -I$(top_builddir) -I$(top_builddir)/gst-libs
GTKDOC_LIBS = \
$(top_builddir)/gst-libs/gst/farsight/libgstfarsight-0.10.la \
+ $(top_builddir)/gst/fsrtpconference/libfsrtpconference_doc.la \
$(GST_BASE_LIBS)
GTKDOC_CC=$(LIBTOOL) --mode=compile $(CC)
diff --git a/docs/plugins/farsight2-plugins-docs.sgml b/docs/plugins/farsight2-plugins-docs.sgml
index 819d54b..e3be561 100644
--- a/docs/plugins/farsight2-plugins-docs.sgml
+++ b/docs/plugins/farsight2-plugins-docs.sgml
@@ -20,5 +20,8 @@
<xi:include href="xml/fs-rawudp-stream-transmitter.xml"/>
<xi:include href="xml/fs-multicast-transmitter.xml"/>
<xi:include href="xml/fs-multicast-stream-transmitter.xml"/>
+ <xi:include href="xml/fs-rtp-session.xml"/>
+ <xi:include href="xml/fs-rtp-stream.xml"/>
+ <xi:include href="xml/fs-rtp-participant.xml"/>
</chapter>
</book>
diff --git a/docs/plugins/farsight2-plugins-sections.txt b/docs/plugins/farsight2-plugins-sections.txt
index 7869767..095ffe1 100644
--- a/docs/plugins/farsight2-plugins-sections.txt
+++ b/docs/plugins/farsight2-plugins-sections.txt
@@ -3,6 +3,7 @@
<TITLE>FsFunnel</TITLE>
FsFunnel
<SUBSECTION Standard>
+FsFunnelClass
FS_FUNNEL
FS_IS_FUNNEL
FS_TYPE_FUNNEL
@@ -13,26 +14,28 @@ FS_IS_FUNNEL_CLASS
<SECTION>
<FILE>videoanyrate</FILE>
-GstVideoanyratePrivate
<TITLE>GstVideoanyrate</TITLE>
GstVideoanyrate
<SUBSECTION Standard>
+GstVideoanyratePrivate
GST_VIDEOANYRATE
GST_IS_VIDEOANYRATE
GST_TYPE_VIDEOANYRATE
gst_videoanyrate_get_type
GST_VIDEOANYRATE_CLASS
+GstVideoanyrateClass
GST_IS_VIDEOANYRATE_CLASS
</SECTION>
<SECTION>
<FILE>fs-rtp-conference</FILE>
-FS_RTP_CONFERENCE_CAST
-FsRtpConferencePrivate
<TITLE>FsRtpConference</TITLE>
FsRtpConference
-fs_codec_to_gst_caps
<SUBSECTION Standard>
+FS_RTP_CONFERENCE_CAST
+FsRtpConferencePrivate
+FsRtpConferenceClass
+fs_codec_to_gst_caps
FS_RTP_CONFERENCE
FS_IS_RTP_CONFERENCE
FS_TYPE_RTP_CONFERENCE
@@ -48,6 +51,8 @@ FS_RAWUDP_TRANSMITTER_CAST
FsRawUdpTransmitterPrivate
<TITLE>FsRawUdpTransmitter</TITLE>
FsRawUdpTransmitter
+<SUBSECTION Standard>
+FsRawUdpTransmitterClass
UdpPort
FsRawUdpAddressUniqueCallbackFunc
fs_rawudp_transmitter_get_udpport
@@ -61,7 +66,6 @@ fs_rawudp_transmitter_udpport_is_pad
fs_rawudp_transmitter_udpport_get_port
fs_rawudp_transmitter_udpport_add_known_address
fs_rawudp_transmitter_udpport_remove_known_address
-<SUBSECTION Standard>
FS_RAWUDP_TRANSMITTER
FS_IS_RAWUDP_TRANSMITTER
FS_TYPE_RAWUDP_TRANSMITTER
@@ -80,6 +84,7 @@ FsRawUdpStreamTransmitter
fs_rawudp_stream_transmitter_register_type
fs_rawudp_stream_transmitter_newv
<SUBSECTION Standard>
+FsRawUdpStreamTransmitterClass
FS_RAWUDP_STREAM_TRANSMITTER
FS_IS_RAWUDP_STREAM_TRANSMITTER
FS_TYPE_RAWUDP_STREAM_TRANSMITTER
@@ -91,16 +96,11 @@ FS_RAWUDP_STREAM_TRANSMITTER_GET_CLASS
<SECTION>
<FILE>fs-multicast-transmitter</FILE>
-FS_MULTICAST_TRANSMITTER_CAST
-FsMulticastTransmitterPrivate
<TITLE>FsMulticastTransmitter</TITLE>
FsMulticastTransmitter
-UdpSock
-fs_multicast_transmitter_get_udpsock
-fs_multicast_transmitter_put_udpsock
-fs_multicast_transmitter_udpsock_inc_sending
-fs_multicast_transmitter_udpsock_dec_sending
<SUBSECTION Standard>
+FsMulticastTransmitterClass
+FS_MULTICAST_TRANSMITTER_CAST
FS_MULTICAST_TRANSMITTER
FS_IS_MULTICAST_TRANSMITTER
FS_TYPE_MULTICAST_TRANSMITTER
@@ -108,17 +108,25 @@ fs_multicast_transmitter_get_type
FS_MULTICAST_TRANSMITTER_CLASS
FS_IS_MULTICAST_TRANSMITTER_CLASS
FS_MULTICAST_TRANSMITTER_GET_CLASS
+<SUBSECTION Private>
+FsMulticastTransmitterPrivate
+UdpSock
+fs_multicast_transmitter_get_udpsock
+fs_multicast_transmitter_put_udpsock
+fs_multicast_transmitter_udpsock_inc_sending
+fs_multicast_transmitter_udpsock_dec_sending
</SECTION>
<SECTION>
<FILE>fs-multicast-stream-transmitter</FILE>
-FS_MULTICAST_STREAM_TRANSMITTER_CAST
-FsMulticastStreamTransmitterPrivate
<TITLE>FsMulticastStreamTransmitter</TITLE>
FsMulticastStreamTransmitter
+<SUBSECTION Standard>
+FS_MULTICAST_STREAM_TRANSMITTER_CAST
+FsMulticastStreamTransmitterPrivate
fs_multicast_stream_transmitter_register_type
fs_multicast_stream_transmitter_newv
-<SUBSECTION Standard>
+FsMulticastStreamTransmitterClass
FS_MULTICAST_STREAM_TRANSMITTER
FS_IS_MULTICAST_STREAM_TRANSMITTER
FS_TYPE_MULTICAST_STREAM_TRANSMITTER
@@ -128,3 +136,69 @@ FS_IS_MULTICAST_STREAM_TRANSMITTER_CLASS
FS_MULTICAST_STREAM_TRANSMITTER_GET_CLASS
</SECTION>
+
+<SECTION>
+<FILE>fs-rtp-session</FILE>
+<TITLE>FsRtpSession</TITLE>
+FsRtpSession
+<SUBSECTION Standard>
+FsRtpSessionClass
+FS_IS_RTP_SESSION
+FS_IS_RTP_SESSION_CLASS
+FS_RTP_SESSION
+FS_RTP_SESSION_CAST
+FS_RTP_SESSION_CLASS
+FS_RTP_SESSION_GET_CLASS
+FS_RTP_SESSION_LOCK
+FS_RTP_SESSION_UNLOCK
+FS_TYPE_RTP_SESSION
+fs_rtp_session_get_type
+<SUBSECTION Private>
+FsRtpSessionPrivate
+fs_rtp_session_associate_ssrc_cname
+fs_rtp_session_bye_ssrc
+fs_rtp_session_new
+fs_rtp_session_new_recv_pad
+fs_rtp_session_request_pt_map
+</SECTION>
+
+<SECTION>
+<FILE>fs-rtp-stream</FILE>
+<TITLE>FsRtpStream</TITLE>
+FsRtpStream
+<SUBSECTION Standard>
+FsRtpStreamClass
+fs_rtp_stream_get_type
+FS_IS_RTP_STREAM
+FS_IS_RTP_STREAM_CLASS
+FS_RTP_STREAM
+FS_RTP_STREAM_CAST
+FS_RTP_STREAM_CLASS
+FS_RTP_STREAM_GET_CLASS
+FS_TYPE_RTP_STREAM
+<SUBSECTION Private>
+FsRtpStreamPrivate
+fs_rtp_stream_add_substream
+fs_rtp_stream_new
+fs_rtp_stream_set_negotiated_codecs
+</SECTION>
+
+
+<SECTION>
+<FILE>fs-rtp-participant</FILE>
+<TITLE>FsRtpParticipant</TITLE>
+FsRtpParticipant
+<SUBSECTION Standard>
+FsRtpParticipantClass
+fs_rtp_participant_get_type
+FS_IS_RTP_PARTICIPANT
+FS_IS_RTP_PARTICIPANT_CLASS
+FS_RTP_PARTICIPANT
+FS_RTP_PARTICIPANT_CAST
+FS_RTP_PARTICIPANT_CLASS
+FS_RTP_PARTICIPANT_GET_CLASS
+FS_TYPE_RTP_PARTICIPANT
+<SUBSECTION Private>
+FsRtpParticipantPrivate
+fs_rtp_participant_new
+</SECTION>
diff --git a/docs/plugins/farsight2-plugins.types b/docs/plugins/farsight2-plugins.types
index 9f4950e..14d6c86 100644
--- a/docs/plugins/farsight2-plugins.types
+++ b/docs/plugins/farsight2-plugins.types
@@ -1 +1,4 @@
#include <gst/gst.h>
+fs_rtp_participant_get_type
+fs_rtp_session_get_type
+fs_rtp_stream_get_type
diff --git a/gst/fsrtpconference/Makefile.am b/gst/fsrtpconference/Makefile.am
index 6f11f1c..7d88b91 100644
--- a/gst/fsrtpconference/Makefile.am
+++ b/gst/fsrtpconference/Makefile.am
@@ -1,6 +1,6 @@
plugin_LTLIBRARIES = libfsrtpconference.la
-libfsrtpconference_la_SOURCES = gstfsrtpconference.c \
+common_SOURCES = \
fs-rtp-conference.c \
fs-rtp-participant.c \
fs-rtp-session.c \
@@ -14,10 +14,12 @@ libfsrtpconference_la_SOURCES = gstfsrtpconference.c \
fs-rtp-dtmf-event-source.c \
fs-rtp-dtmf-sound-source.c \
fs-rtp-marshal.c
+libfsrtpconference_la_SOURCES = gstfsrtpconference.c $(common_SOURCES)
BUILT_SOURCES = \
fs-rtp-marshal.c \
- fs-rtp-marshal.h
+ fs-rtp-marshal.h \
+ gstfsrtpconference_doc.c
noinst_HEADERS = \
fs-rtp-conference.h \
@@ -51,6 +53,19 @@ libfsrtpconference_la_LIBADD = \
$(GST_BASE_LIBS) \
$(GST_LIBS)
+
+if ENABLE_GTK_DOC
+noinst_LTLIBRARIES = libfsrtpconference_doc.la
+
+libfsrtpconference_doc_la_SOURCES = gstfsrtpconference_doc.c $(common_SOURCES)
+libfsrtpconference_doc_la_CFLAGS = $(libfsrtpconference_la_CFLAGS)
+libfsrtpconference_doc_la_LIBADD = $(libfsrtpconference_la_LIBADD)
+
+gstfsrtpconference_doc.c: gstfsrtpconference.c
+ sed -e 's:GST_PLUGIN_DEFINE:GST_PLUGIN_DEFINE_STATIC:' \
+ gstfsrtpconference.c > gstfsrtpconference_doc.c
+endif
+
fs-rtp-marshal.h: fs-rtp-marshal.list Makefile
glib-genmarshal --header --prefix=_fs_rtp_marshal $(srcdir)/$< > $@.tmp
mv $@.tmp $@
--
1.5.6.5
More information about the farsight-commits
mailing list