[farsight2/master] Format the plugin doc nicely

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


---
 docs/plugins/farsight2-plugins-docs.sgml    |   32 +++++++++++++-------------
 docs/plugins/farsight2-plugins-sections.txt |   12 ++++++----
 2 files changed, 23 insertions(+), 21 deletions(-)

diff --git a/docs/plugins/farsight2-plugins-docs.sgml b/docs/plugins/farsight2-plugins-docs.sgml
index e3be561..f20ec54 100644
--- a/docs/plugins/farsight2-plugins-docs.sgml
+++ b/docs/plugins/farsight2-plugins-docs.sgml
@@ -3,25 +3,25 @@
                "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-plugins Reference Manual</title>
-    <releaseinfo>
-      for farsight2-plugins [VERSION]
-      The latest version of this documentation can be found on-line at
-      <ulink role="online-location" url="http://[SERVER]/farsight2-plugins/index.html">http://[SERVER]/farsight2-plugins/</ulink>.
-    </releaseinfo>
+    <title>Farsight Plugins Manual</title>
   </bookinfo>
 
-  <chapter>
-    <title>[Insert title here]</title>
-    <xi:include href="xml/fs-funnel.xml"/>
-    <xi:include href="xml/videoanyrate.xml"/>
+  <part>
+    <title>RTP Plugin</title>
     <xi:include href="xml/fs-rtp-conference.xml"/>
-    <xi:include href="xml/fs-rawudp-transmitter.xml"/>
-    <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-participant.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>
+    <chapter>
+      <title>Transmitters</title>
+      <xi:include href="xml/fs-rawudp-stream-transmitter.xml"/>
+      <xi:include href="xml/fs-multicast-stream-transmitter.xml"/>
+    </chapter>
+  </part>
+
+  <part>
+    <title>Utility elements</title>
+    <xi:include href="xml/fs-funnel.xml"/>
+    <xi:include href="xml/videoanyrate.xml"/>
+  </part>
 </book>
diff --git a/docs/plugins/farsight2-plugins-sections.txt b/docs/plugins/farsight2-plugins-sections.txt
index 095ffe1..32ba180 100644
--- a/docs/plugins/farsight2-plugins-sections.txt
+++ b/docs/plugins/farsight2-plugins-sections.txt
@@ -47,11 +47,10 @@ FS_RTP_CONFERENCE_GET_CLASS
 
 <SECTION>
 <FILE>fs-rawudp-transmitter</FILE>
-FS_RAWUDP_TRANSMITTER_CAST
-FsRawUdpTransmitterPrivate
 <TITLE>FsRawUdpTransmitter</TITLE>
 FsRawUdpTransmitter
-<SUBSECTION Standard>
+<SUBSECTION Private>
+FsRawUdpTransmitterPrivate
 FsRawUdpTransmitterClass
 UdpPort
 FsRawUdpAddressUniqueCallbackFunc
@@ -66,6 +65,8 @@ 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_CAST
 FS_RAWUDP_TRANSMITTER
 FS_IS_RAWUDP_TRANSMITTER
 FS_TYPE_RAWUDP_TRANSMITTER
@@ -77,13 +78,14 @@ FS_RAWUDP_TRANSMITTER_GET_CLASS
 
 <SECTION>
 <FILE>fs-rawudp-stream-transmitter</FILE>
-FS_RAWUDP_STREAM_TRANSMITTER_CAST
-FsRawUdpStreamTransmitterPrivate
 <TITLE>FsRawUdpStreamTransmitter</TITLE>
 FsRawUdpStreamTransmitter
+<SUBSECTION Private>
+FsRawUdpStreamTransmitterPrivate
 fs_rawudp_stream_transmitter_register_type
 fs_rawudp_stream_transmitter_newv
 <SUBSECTION Standard>
+FS_RAWUDP_STREAM_TRANSMITTER_CAST
 FsRawUdpStreamTransmitterClass
 FS_RAWUDP_STREAM_TRANSMITTER
 FS_IS_RAWUDP_STREAM_TRANSMITTER
-- 
1.5.6.5




More information about the farsight-commits mailing list