More porting to markdown
authorThibault Saunier <tsaunier@igalia.com>
Wed, 1 May 2019 16:56:44 +0000 (12:56 -0400)
committerThibault Saunier <tsaunier@igalia.com>
Mon, 13 May 2019 14:30:35 +0000 (10:30 -0400)
ges/ges-audio-source.c
ges/ges-title-source.c
ges/ges-types.h
ges/ges-video-source.c

index 8997107..03ee44c 100644 (file)
  * You can use the following children properties through the
  * #ges_track_element_set_child_property and alike set of methods:
  *
- * <informaltable frame="none">
- * <tgroup cols="3">
- * <colspec colname="properties_type" colwidth="150px"/>
- * <colspec colname="properties_name" colwidth="200px"/>
- * <colspec colname="properties_flags" colwidth="400px"/>
- * <tbody>
- * <row>
- *  <entry role="property_type"><link linkend="gdouble"><type>double</type></link></entry>
- *  <entry role="property_name"><link linkend="GESAudioSource--volume">volume</link></entry>
- *  <entry>volume factor, 1.0=100%.</entry>
- * </row>
- * <row>
- *  <entry role="property_type"><link linkend="gboolean"><type>gboolean</type></link></entry>
- *  <entry role="property_name"><link linkend="GESAudioSource--mute">mute</link></entry>
- *  <entry>mute channel.</entry>
- * </row>
- * </tbody>
- * </tgroup>
- * </informaltable>
+ * - #gdouble `volume`: volume factor, 1.0=100%.
+ * - #gboolean `mute`: mute channel.
+ *
  */
 #ifdef HAVE_CONFIG_H
 #include "config.h"
index f67115b..239780e 100644 (file)
  * ## Children Properties
  *
  * You can use the following children properties through the
- * #ges_track_element_set_child_property and alike set of methods:
- * <informaltable frame="none">
- * <tgroup cols="3">
- * <colspec colname="properties_type" colwidth="150px"/>
- * <colspec colname="properties_name" colwidth="200px"/>
- * <colspec colname="properties_flags" colwidth="400px"/>
- * <tbody>
- * <row>
- *  <entry role="property_type"><link linkend="guint"><type>guint</type></link></entry>
- *  <entry role="property_name"><link linkend="GESTileSource--background">background</link></entry>
- *  <entry>The color of the background</entry>
- * </row>
- * <row>
- *  <entry role="property_type"><link linkend="guint"><type>guint</type></link></entry>
- *  <entry role="property_name"><link linkend="GESTileSource--color">color</link></entry>
- *  <entry>The color of the text</entry>
- * </row>
- * <row>
- *   <entry role="property_type"><link linkend="gchar"><type>gchar</type></link></entry>
- *   <entry role="property_name"><link linkend="GESTileSource--font-desc">font-desc</link></entry>
- *   <entry>Pango font description string</entry>
- * </row>
- * <row>
- *  <entry role="property_type"><link linkend="GESTextHAlign"><type>GESTextHAlign</type></link></entry>
- *  <entry role="property_name"><link linkend="GESTileSource--halignment">halignment</link></entry>
- *  <entry>Horizontal alignment of the text</entry>
- * </row>
- * <row>
- *  <entry role="property_type"><link linkend="gchar"><type>gchar</type></link></entry>
- *  <entry role="property_name"><link linkend="GESTileSource--text">text</link></entry>
- *  <entry>The text to be rendered</entry>
- * </row>
- * <row>
- *  <entry role="property_type"><link linkend="GESTextVAlign"><type>GESTextVAlign</type></link>
- *  </entry><entry role="property_name"><link linkend="GESTileSource--valignment">valignment</link>
- *  </entry><entry>Vertical alignent of the text</entry>
- * </row>
- * <row>
- *  <entry role="property_type"><link linkend="gdouble"><type>gdouble</type></link></entry>
- *  <entry role="property_name"><link linkend="GESTileSource--xpos">xpos</link></entry>
- *  <entry>The horizontal position of the text</entry>
- * </row>
- * <row><entry role="property_type"><link linkend="gdouble"><type>gdouble</type></link></entry>
- *  <entry role="property_name"><link linkend="GESTileSource--ypos">ypos</link></entry>
- *  <entry>The vertical position of the text</entry>
- * </row>
- * <row><entry role="property_type"><link linkend="gboolean"><type>gboolean</type></link></entry>
- *  <entry role="property_name"><link linkend="GESTileSource--shaded-background">shaded-background</link></entry>
- *  <entry>Whether to shade the background under the text area</entry>
- * </row>
- * <row><entry role="property_type"><link linkend="guint"><type>guint</type></link></entry>
- *  <entry role="property_name"><link linkend="GESTileSource--outline-color">outline-color</link></entry>
- *  <entry>Color to use for outline the text (big-endian ARGB).</entry>
- * </row>
- * </tbody>
- * </tgroup>
- * </informaltable>
+ * #ges_timeline_element_set_child_property and alike set of methods:
+ *
+ *  - #gchar `text`: The text to be rendered
+ *  - #guint `background`: The color of the background
+ *  - #guint `color`: The color of the text
+ *  - #gchar `font-desc`: Pango font description string
+ *  - #GESTextHAlign `halignment`: Horizontal alignment of the text
+ *  - #GESTextVAlign `valignment`: Vertical alignent of the text
+ *  - #gdouble `xpos`: The horizontal position of the text
+ *  - #gdouble `ypos`: The vertical position of the text
+ *  - #gboolean `shaded-background`: Whether to shade the background under the text area
+ *  - #guint `outline-color`: Color to use for outline the text (big-endian ARGB).
  */
 #ifdef HAVE_CONFIG_H
 #include "config.h"
index 4a66d1f..6d6f468 100644 (file)
 
 G_BEGIN_DECLS
 
-/* Padding */
+/**
+ * GES_PADDING: (attributes doc.skip=true)
+ */
 #define GES_PADDING         4
 
-/* padding for very extensible base classes */
+/**
+ * GES_PADDING_LARGE: (attributes doc.skip=true)
+ */
 #define GES_PADDING_LARGE   20
 
 /* Type definitions */
index d8b4a4a..94f7c60 100644 (file)
  * @title: GESVideoSource
  * @short_description: Base Class for video sources
  *
- * # Children Properties:
+ * ## Children Properties:
+ *
  * You can use the following children properties through the
  * #ges_track_element_set_child_property and alike set of methods:
- *
- * <informaltable frame="none">
- * <tgroup cols="3">
- * <colspec colname="properties_type" colwidth="150px"/>
- * <colspec colname="properties_name" colwidth="200px"/>
- * <colspec colname="properties_flags" colwidth="400px"/>
- * <tbody>
- * <row>
- *  <entry role="property_type"><link linkend="gdouble"><type>double</type></link></entry>
- *  <entry role="property_name"><link linkend="GESVideoSource--alpha">alpha</link></entry>
- *  <entry>The desired alpha for the stream.</entry>
- * </row>
- * <row>
- *  <entry role="property_type"><link linkend="gint"><type>gint</type></link></entry>
- *  <entry role="property_name"><link linkend="GESVideoSource--posx">posx</link></entry>
- *  <entry>The desired x position for the stream.</entry>
- * </row>
- * <row>
- *  <entry role="property_type"><link linkend="gint"><type>gint</type></link></entry>
- *  <entry role="property_name"><link linkend="GESVideoSource--posy">posy</link></entry>
- *  <entry>The desired y position for the stream</entry>
- * </row>
- * <row>
- *  <entry role="property_type"><link linkend="gint"><type>gint</type></link></entry>
- *  <entry role="property_name"><link linkend="GESVideoSource--width">width</link></entry>
- *  <entry>The desired width for that source. Set to 0 if size is not mandatory, will be set to width of the current track.</entry>
- * </row>
- * <row>
- *  <entry role="property_type"><link linkend="gint"><type>gint</type></link></entry>
- *  <entry role="property_name"><link linkend="GESVideoSource--height">height</link></entry>
- *  <entry>The desired height for that source. Set to 0 if size is not mandatory, will be set to height of the current track.</entry>
- * </row>
- * <row>
- *  <entry role="property_type"><link linkend="GstDeinterlaceModes"><type>GstDeinterlaceModes</type></link></entry>
- *  <entry role="property_name"><link linkend="GESVideoSource--deinterlace-mode">deinterlace-mode</link></entry>
- *  <entry>Deinterlace Mode</entry>
- * </row>
- * <row>
- *  <entry role="property_type"><link linkend="GstDeinterlaceFields"><type>GstDeinterlaceFields</type></link></entry>
- *  <entry role="property_name"><link linkend="GESVideoSource--deinterlace-fields">deinterlace-fields</link></entry>
- *  <entry>Fields to use for deinterlacing</entry>
- * </row>
- * <row>
- *  <entry role="property_type"><link linkend="GstDeinterlaceFieldLayout"><type>GstDeinterlaceFieldLayout</type></link></entry>
- *  <entry role="property_name"><link linkend="GESVideoSource--deinterlace-tff">deinterlace-tff</link></entry>
- *  <entry>Deinterlace top field first</entry>
- * </row>
- * <row>
- *  <entry role="property_type"><link linkend="GstVideoOrientationMethod"><type>GstVideoOrientationMethod</type></link></entry>
- *  <entry role="property_name"><link linkend="GESVideoSource--video-direction">video-direction</link></entry>
- *  <entry>The desired video rotation and flipping.</entry>
- * </row>
- * </tbody>
- * </tgroup>
- * </informaltable>
+ * 
+ * - #gdouble `alpha`: The desired alpha for the stream.
+ * - #gint `posx`: The desired x position for the stream.
+ * - #gint `posy`: The desired y position for the stream
+ * - #gint `width`: The desired width for that source.
+ *   Set to 0 if size is not mandatory, will be set to width of the current track.
+ * - #gint `height`: The desired height for that source.
+ *   Set to 0 if size is not mandatory, will be set to height of the current track.
+ * - #GstDeinterlaceModes `deinterlace-mode`: Deinterlace Mode
+ * - #GstDeinterlaceFields `deinterlace-fields`: Fields to use for deinterlacing
+ * - #GstDeinterlaceFieldLayout `deinterlace-tff`: Deinterlace top field first
+ * - #GstVideoOrientationMethod `video-direction`: The desired video rotation and flipping.
  */
 #ifdef HAVE_CONFIG_H
 #include "config.h"