GNOME Bugzilla – Bug 714988
docs: Add missing types, remove stale types and fix warnings...
Last modified: 2014-02-25 22:28:27 UTC
When compiling gst-rtsp-server docs like so: make -C docs/libs clean html I previously got the lost of warnings as can be seen below. These have now all been fixed. Only complains about undocumented members remain. ../../gst/rtsp-server//rtsp-context.c:25: warning: Section rtsp-context is not defined in the gst-rtsp-server-sections.txt file. ./gst-rtsp-server-sections.txt:82: warning: No declaration found for GstRTSPClientState. ./gst-rtsp-server-sections.txt:83: warning: No declaration found for gst_rtsp_client_state_get_current. ./gst-rtsp-server-sections.txt:84: warning: No declaration found for gst_rtsp_client_state_pop_current. ./gst-rtsp-server-sections.txt:85: warning: No declaration found for gst_rtsp_client_state_push_current. ./gst-rtsp-server-unused.txt:1: warning: 14 unused declarations.They should be added to gst-rtsp-server-sections.txt in the appropriate place. In gtk-doc.xsl: For acronym (transfer full) no value found! In gtk-doc.xsl: For acronym (allow-none) no value found! In gtk-doc.xsl: For acronym (scope call) no value found! In gtk-doc.xsl: For acronym (element-type) no value found! In gtk-doc.xsl: For acronym (transfer none) no value found! In gtk-doc.xsl: For acronym (out) no value found! In gtk-doc.xsl: For acronym (scope notified) no value found! html/GstRTSPMediaFactory.html:187: warning: no link for: 'd' -> (<code class="literal">d</code>). html/gst-rtsp-server-GstRTSPSessionMedia.html:113: warning: no link for: 'GstRTPSessionMedia' -> (<span class="type">GstRTPSessionMedia</span>). html/gst-rtsp-server-GstRTSPToken.html:336: warning: no link for: 'GstRTSPPermission' -> (<span class="type">GstRTSPPermission</span>). html/GstRTSPAuth.html:91: warning: no link for: 'GST-RTSP-AUTH-CHECK-:CAPS' -> (<span class="type">GST_RTSP_AUTH_CHECK_</span>). html/GstRTSPAuth.html:444: warning: no link for: 'GstRTSPtoken' -> (<span class="type">GstRTSPtoken</span>). html/GstRTSPStream.html:536: warning: no link for: 'Gstbin' -> (<span class="type">Gstbin</span>). html/gst-rtsp-server-GstRTSPAddressPool.html:531: warning: no link for: 'GST-RTSP-ADDRESS-POOL-OK:CAPS' -> (<span class="type">GST_RTSP_ADDRESS_POOL_OK</span>).
Created attachment 261212 [details] [review] [PATCH 1/5] docs: Improve documentation
Created attachment 261213 [details] [review] [PATCH 2/5] rtsp-*: Fix type name typos in comments
Created attachment 261214 [details] [review] [PATCH 3/5] rtsp-*: Refer to NULL as a constant in comments
Created attachment 261215 [details] [review] [PATCH 4/5] rtsp-media/-factory: Fix request pad name comments
Created attachment 261216 [details] [review] [PATCH 5/5] rtsp-mount-points: Fix typo in comment
I separated the changes into logical patches to make it easier to review, but feel fee to squash these if you like.