ges: Various doc fixups and cleanups

This commit is contained in:
Edward Hervey 2012-01-12 16:34:13 +01:00
parent 282c3c4b49
commit ee237ec523
8 changed files with 28 additions and 18 deletions

View file

@ -5,6 +5,10 @@
<TITLE>Initialization</TITLE>
ges_init
ges_version
GES_VERSION_MAJOR
GES_VERSION_MICRO
GES_VERSION_MINOR
GES_VERSION_NANO
<SUBSECTION Standard>
GES_PADDING
</SECTION>
@ -352,10 +356,6 @@ ges_timeline_pipeline_preview_set_video_sink
ges_timeline_pipeline_get_thumbnail_buffer
ges_timeline_pipeline_get_thumbnail_rgb24
ges_timeline_pipeline_save_thumbnail
ges_timeline_pipeline_preview_get_audio_sink
ges_timeline_pipeline_preview_get_video_sink
ges_timeline_pipeline_preview_set_audio_sink
ges_timeline_pipeline_preview_set_video_sink
<SUBSECTION Standard>
GESTimelinePipelineClass
GESTimelinePipelinePrivate
@ -760,6 +760,7 @@ ges_formatter_save_to_uri
ges_formatter_new_for_uri
ges_formatter_can_load_uri
ges_formatter_can_save_uri
ges_formatter_update_source_uri
<SUBSECTION Standard>
ges_formatter_get_type
GES_FORMATTER
@ -806,6 +807,8 @@ ges_pitivi_formatter_set_sources
ges_pitivi_formatter_get_sources
<SUBSECTION Standard>
GESPitiviFormatterClass
GESPitiviFormatterPrivate
GES_TYPE_PITIVI_FORMATTER
GES_IS_PITIVI_FORMATTER
GES_IS_PITIVI_FORMATTER_CLASS
GES_PITIVI_FORMATTER

View file

@ -1111,7 +1111,7 @@ pitivi_formatter_update_source_uri (GESFormatter * formatter,
/**
* ges_pitivi_formatter_set_sources:
* @formatter: The #GESPitiviFormatter to set sources on
* @infos: (transfer none): (element-type GstDiscovererInfo):
* @infos: (transfer none) (element-type GstDiscovererInfo):
* The #GstDiscovererInfo infos to add as sources.
*
* Add @infos as the formatter sources so we can save sources that are
@ -1146,7 +1146,7 @@ ges_pitivi_formatter_set_sources (GESPitiviFormatter * formatter, GList * infos)
* ges_pitivi_formatter_get_sources:
* @formatter: The #GESPitiviFormatter to get sources from
*
* Returns: (transfer full): (element-type utf8): %TRUE if everything went
* Returns: (transfer full) (element-type utf8): %TRUE if everything went
* fine, %FALSE otherwise
*/
GList *

View file

@ -169,7 +169,7 @@ ges_timeline_layer_class_init (GESTimelineLayerClass * klass)
"The priority of the layer", 0, G_MAXUINT, 0, G_PARAM_READWRITE));
/**
* GESTimelineLayer:auto_transitioning
* GESTimelineLayer:auto-transition
*
* Sets whether transitions are added automagically when timeline objects overlap.
*/
@ -879,9 +879,10 @@ ges_timeline_layer_set_priority (GESTimelineLayer * layer, guint priority)
* ges_timeline_layer_get_auto_transition:
* @layer: a #GESTimelineLayer
*
* Get the priority of @layer within the timeline.
* Gets whether transitions are automatically added when objects
* overlap or not.
*
* Returns: The priority of the @layer within the timeline.
* Returns: %TRUE if transitions are automatically added, else %FALSE.
*/
gboolean
ges_timeline_layer_get_auto_transition (GESTimelineLayer * layer)

View file

@ -107,7 +107,8 @@ guint ges_timeline_layer_get_priority (GESTimelineLayer * layer);
gboolean ges_timeline_layer_get_auto_transition (GESTimelineLayer * layer);
void ges_timeline_layer_set_auto_transition (GESTimelineLayer * layer, gboolean auto_transition);
void ges_timeline_layer_set_auto_transition (GESTimelineLayer * layer,
gboolean auto_transition);
GList* ges_timeline_layer_get_objects (GESTimelineLayer * layer);

View file

@ -1187,11 +1187,14 @@ ges_timeline_get_layers (GESTimeline * timeline)
/**
* ges_timeline_enable_update:
* @timeline: a #GESTimeline
* @enabled: TRUE if the timeline must be updated, FALSE otherwise.
* @enabled: Whether the timeline should update on every change or not.
*
* Calls the enable_update function of the tracks contained by the timeline.
* Control whether the timeline is updated for every change happening within.
*
* Returns: True if success, FALSE otherwise.
* Users will want to use this method with %FALSE before doing lots of changes,
* and then call again with %TRUE for the changes to take effect in one go.
*
* Returns: %TRUE if the update status could be changed, else %FALSE.
*/
gboolean
ges_timeline_enable_update (GESTimeline * timeline, gboolean enabled)

View file

@ -688,11 +688,14 @@ ges_track_get_timeline (GESTrack * track)
/**
* ges_track_enable_update:
* @track: a #GESTrack
* @enabled: %TRUE if the composition must be updated, FALSE otherwise.
* @enabled: Whether the track should update on every change or not.
*
* Sets the @track 's composition update property to @enabled .
* Control whether the track is updated for every change happening within.
*
* Returns: True if success, %FALSE otherwise.
* Users will want to use this method with %FALSE before doing lots of changes,
* and then call again with %TRUE for the changes to take effect in one go.
*
* Returns: %TRUE if the update status could be changed, else %FALSE.
*/
gboolean
ges_track_enable_update (GESTrack * track, gboolean enabled)

View file

@ -326,7 +326,6 @@ GST_START_TEST (test_layer_automatic_transition)
}
fail_unless (res == TRUE);
printf ("zob\n");
}
GST_END_TEST;

View file

@ -660,7 +660,7 @@ GST_START_TEST (test_pitivi_file_load)
ges_formatter_load_from_uri (formatter, timeline, uri);
g_timeout_add (1000, (GSourceFunc) g_main_loop_quit, mainloop);
g_main_loop_run (mainloop);
printf ("saloperie\n");
formatter = GES_FORMATTER (ges_pitivi_formatter_new ());
ges_formatter_save_to_uri (formatter, timeline, save_uri);
formatter = GES_FORMATTER (ges_pitivi_formatter_new ());