mirrors/gstreamer
mirrors/gstreamer
1
1
Fork 0
mirror of https://gitlab.freedesktop.org/gstreamer/gstreamer.git synced 2024-10-04 17:52:29 +00:00
Code Issues 1 Projects Releases Wiki Activity

docs: Improve documentation

Browse source 
* Include annotation-glossary to quiet gtk-doc
  * Rename remaining ClientState -> Context
  * Rename object hierarchy file
  * Remove stale chapter references
  * Add missing function and object references
  * Include missing GstRTSPAddressPoolResult

https://bugzilla.gnome.org/show_bug.cgi?id=714988
This commit is contained in:
Sebastian Rasmussen 2013-11-22 00:45:17 +01:00 committed by Tim-Philipp Müller
parent 33c4bdfa01
commit 3052b28859
3 changed files with 29 additions and 60 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
docs/README
View file

@ -425,7 +425,7 @@ GstRTSPClient
- Handle RTSP Requests from connected clients. All other objects
are called by this object.
GstRTSPClientState
GstRTSPContext
- Helper structure contaning the current state of the request
handled by the client.
@ -482,7 +482,7 @@ GstRTSPThreadPool
GstRTSPAuth
- Hooks for checking authorizations, all client activity will call this
object with the GstRTSPClientState structure. By default it supports
object with the GstRTSPContext structure. By default it supports
basic authentication.
GstRTSPToken

56
docs/libs/gst-rtsp-server-docs.sgml
View file

@ -16,6 +16,7 @@
<chapter>
<xi:include href="xml/rtsp-server.xml"/>
<xi:include href="xml/rtsp-client.xml"/>
<xi:include href="xml/rtsp-context.xml"/>
<xi:include href="xml/rtsp-mount-points.xml"/>
<xi:include href="xml/rtsp-media-factory.xml"/>
<xi:include href="xml/rtsp-media-factory-uri.xml"/>
@ -34,58 +35,7 @@
<xi:include href="xml/rtsp-params.xml"/>
</chapter>
<!-- <chapter> -->
<!-- <title>Base Classes</title> -->
<!-- <xi:include href="xml/ges-timeline.xml"/> -->
<!-- <xi:include href="xml/ges-timeline-layer.xml"/> -->
<!-- <xi:include href="xml/ges-timeline-object.xml"/> -->
<!-- <xi:include href="xml/ges-timeline-source.xml"/> -->
<!-- <xi:include href="xml/ges-timeline-overlay.xml"/> -->
<!-- <xi:include href="xml/ges-track.xml"/> -->
<!-- <xi:include href="xml/ges-track-object.xml"/> -->
<!-- <xi:include href="xml/ges-track-source.xml"/> -->
<!-- <xi:include href="xml/ges-track-operation.xml"/> -->
<!-- </chapter> -->
<!-- <chapter> -->
<!-- <title>Timeline objects</title> -->
<!-- <xi:include href="xml/ges-timeline-filesource.xml"/> -->
<!-- <xi:include href="xml/ges-timeline-title-source.xml"/> -->
<!-- <xi:include href="xml/ges-timeline-test-source.xml"/> -->
<!-- <xi:include href="xml/ges-timeline-text-overlay.xml"/> -->
<!-- <xi:include href="xml/ges-timeline-transition.xml"/> -->
<!-- </chapter> -->
<!-- <chapter> -->
<!-- <title>Track objects</title> -->
<!-- <xi:include href="xml/ges-track-filesource.xml"/> -->
<!-- <xi:include href="xml/ges-track-title-source.xml"/> -->
<!-- <xi:include href="xml/ges-track-audio-test-source.xml"/> -->
<!-- <xi:include href="xml/ges-track-video-test-source.xml"/> -->
<!-- <xi:include href="xml/ges-track-text-overlay.xml"/> -->
<!-- <xi:include href="xml/ges-track-transition.xml"/> -->
<!-- <xi:include href="xml/ges-track-video-transition.xml"/> -->
<!-- <xi:include href="xml/ges-track-audio-transition.xml"/> -->
<!-- </chapter> -->
<!-- <chapter> -->
<!-- <title>Simple Timeline interface</title> -->
<!-- <xi:include href="xml/ges-simple-timeline-layer.xml"/> -->
<!-- </chapter> -->
<!-- <chapter> -->
<!-- <title>Convenience classes</title> -->
<!-- <xi:include href="xml/ges-timeline-pipeline.xml"/> -->
<!-- <xi:include href="xml/ges-custom-timeline-source.xml"/> -->
<!-- </chapter> -->
<!-- <chapter> -->
<!-- <title>Serialization Classes</title> -->
<!-- <xi:include href="xml/ges-formatter.xml"/> -->
<!-- <xi:include href="xml/ges-keyfile-formatter.xml"/> -->
<!-- </chapter> -->
<chapter id="ges-hierarchy">
<chapter id="rtsp-server-hierarchy">
<title>Object Hierarchy</title>
<xi:include href="xml/tree_index.sgml"/>
</chapter>
@ -94,4 +44,6 @@
<title>API Index</title>
<xi:include href="xml/api-index-full.xml"><xi:fallback /></xi:include>
</index>
<xi:include href="xml/annotation-glossary.xml"><xi:fallback /></xi:include>
</book>

29
docs/libs/gst-rtsp-server-sections.txt
View file

@ -13,6 +13,7 @@ gst_rtsp_address_free
<SUBSECTION AddressPool>
GstRTSPAddressPool
GstRTSPAddressPoolClass
GstRTSPAddressPoolResult
gst_rtsp_address_pool_new
gst_rtsp_address_pool_clear
gst_rtsp_address_pool_dump
@ -47,6 +48,8 @@ gst_rtsp_auth_make_basic
gst_rtsp_auth_add_basic
gst_rtsp_auth_remove_basic
gst_rtsp_auth_check
gst_rtsp_auth_get_default_token
gst_rtsp_auth_set_default_token
<SUBSECTION AuthChecks>
GST_RTSP_AUTH_CHECK_CONNECT
@ -78,12 +81,6 @@ gst_rtsp_auth_get_type
<SECTION>
<FILE>rtsp-client</FILE>
<TITLE>GstRTSPClient</TITLE>
<SUBSECTION ClientState>
GstRTSPClientState
gst_rtsp_client_state_get_current
gst_rtsp_client_state_pop_current
gst_rtsp_client_state_push_current
<SUBSECTION Client>
GstRTSPClient
GstRTSPClientClass
@ -128,6 +125,17 @@ GstRTSPClientPrivate
gst_rtsp_client_get_type
</SECTION>
<SECTION>
<FILE>rtsp-context</FILE>
<TITLE>GstRTSPContext</TITLE>
GstRTSPContext
gst_rtsp_context_get_current
gst_rtsp_context_push_current
gst_rtsp_context_pop_current
<SUBSECTION Standard>
gst_rtsp_context_get_type
</SECTION>
<SECTION>
<FILE>rtsp-media</FILE>
<TITLE>GstRTSPMedia</TITLE>
@ -273,6 +281,7 @@ gst_rtsp_mount_points_new
gst_rtsp_mount_points_add_factory
gst_rtsp_mount_points_remove_factory
gst_rtsp_mount_points_match
gst_rtsp_mount_points_make_path
<SUBSECTION Standard>
GST_RTSP_MOUNT_POINTS_CAST
GST_RTSP_MOUNT_POINTS_CLASS_CAST
@ -503,6 +512,9 @@ gst_rtsp_stream_set_mtu
gst_rtsp_stream_get_dscp_qos
gst_rtsp_stream_set_dscp_qos
gst_rtsp_stream_get_protocols
gst_rtsp_stream_set_protocols
gst_rtsp_stream_get_address_pool
gst_rtsp_stream_set_address_pool
gst_rtsp_stream_reserve_address
@ -525,6 +537,10 @@ gst_rtsp_stream_remove_transport
gst_rtsp_stream_get_rtp_socket
gst_rtsp_stream_get_rtcp_socket
GstRTSPStreamTransportFilterFunc
gst_rtsp_stream_transport_filter
<SUBSECTION Standard>
GST_RTSP_STREAM_CAST
GST_RTSP_STREAM_CLASS_CAST
@ -600,6 +616,7 @@ gst_rtsp_thread_pool_get_max_threads
gst_rtsp_thread_pool_set_max_threads
gst_rtsp_thread_pool_get_thread
gst_rtsp_thread_pool_cleanup
<SUBSECTION Standard>
GST_RTSP_THREAD_CAST
GST_RTSP_THREAD_POOL_CAST