GNOME Bugzilla – Bug 758768
documentation - add CameraManager, Types and index; fix build warnings
Last modified: 2016-02-14 23:41:55 UTC
Some suggestions attached to improve the docs. Fixing build warnings: 0001 fix typo in video_sink_get_frame return value 0002 add missing parameter description for content_new_with_sink 0003 don't use tmpl build step when creating documentation 0004 add API indices Provide targets for cross-references and replaces external links to foldoc.org: 0005 add annotation glossary (also fixes build warnings) 0006 add Clutter-Gst types 0007 add CameraManager Some build warnings remain: ../../clutter-gst/clutter-gst-types.h:107: warning: Field description for ClutterGstVideoResolution::par_n is missing in source code comment block. ../../clutter-gst/clutter-gst-types.h:107: warning: Field description for ClutterGstVideoResolution::par_d is missing in source code comment block. ../../clutter-gst/clutter-gst-playback.h:98: warning: Field description for ClutterGstPlaybackClass::should_buffer is missing in source code comment block. ../../clutter-gst/clutter-gst-playback.h:98: warning: Field description for ClutterGstPlaybackClass::download_buffering is not used from source code comment block. ../../clutter-gst/clutter-gst-video-sink.h:91: warning: Field description for ClutterGstVideoSinkClass::new_overlays is missing in source code comment block. ... html/clutter-gst-Video-Sink.html:199: warning: no link for: 'clutter-gst-video-sink-attach-frame' -> (<code class="function">clutter_gst_video_sink_attach_frame()</code>).
Created attachment 316431 [details] [review] fix typo in video_sink_get_frame return value
Created attachment 316432 [details] [review] add missing parameter description for content_new_with_sink
Created attachment 316433 [details] [review] don't use tmpl build step when creating documentation
Created attachment 316434 [details] [review] add API indices Generate index sections by adding name-space to MKDB_OPTIONS
Created attachment 316435 [details] [review] add annotation glossary - Replaces external links to foldoc - Fixes build warnings e.g.: In gtk-doc.xsl: For acronym (transfer none) no value found!
Created attachment 316436 [details] [review] add ClutterGst types
Created attachment 316437 [details] [review] add CameraManager
Review of attachment 316431 [details] [review]: Looks good.
Review of attachment 316432 [details] [review]: Looks good.
Review of attachment 316437 [details] [review]: Looks good.
Review of attachment 316431 [details] [review]: Pushed to 3.0 branch.
Review of attachment 316432 [details] [review]: Pushed to 3.0 branch.
Review of attachment 316437 [details] [review]: Pushed to 3.0 branch.
Review of attachment 316433 [details] [review]: Pushed to 3.0 branch.
Review of attachment 316434 [details] [review]: Pushed to 3.0 branch.
Review of attachment 316435 [details] [review]: Pushed to 3.0 branch.
Review of attachment 316436 [details] [review]: Pushed to 3.0 branch.
(In reply to Lionel Landwerlin from comment #11) > Review of attachment 316431 [details] [review] [review]: > > Pushed to 3.0 branch. Doesn't look like this one actually made it in: fix typo in video_sink_get_frame return value
(In reply to Lionel Landwerlin from comment #12) > Review of attachment 316432 [details] [review] [review]: > > Pushed to 3.0 branch. Or this: documentation: add missing parameter description for content_new_with_sink
(In reply to Lionel Landwerlin from comment #13) > Review of attachment 316437 [details] [review] [review]: > > Pushed to 3.0 branch. Or this: documentation: add CameraManager
Sorry for that, landed on the 3.0 branch for good.