mirrors/gstreamer
mirrors/gstreamer
1
1
Fork 0
mirror of https://gitlab.freedesktop.org/gstreamer/gstreamer.git synced 2024-07-02 04:35:55 +00:00
Code Issues 1 Projects Releases Wiki Activity

massive update to doc comments

Browse source
This commit is contained in:
Brandon Lewis 2010-06-14 19:19:23 +02:00 committed by Edward Hervey
parent 709332ef09
commit b0358d5da1
14 changed files with 49 additions and 31 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
docs/libs/ges-sections.txt
View file

@ -331,8 +331,9 @@ GES_TIMELINE_TITLE_SOURCE_GET_CLASS
<SECTION>
<FILE>ges-track-video-background-source</FILE>
<TITLE>GESTrackVideoBackgroundSource</TITLE>
GESTrackAudioBackgroundSource
GESTrackAudioBackgroundSourceClass
GESTrackVideoBackgroundSource
GESTrackVideoBackgroundSourceClass
GESTrackVideoBgSrcPattern
ges_track_video_background_source_new
ges_track_vbg_src_get_type
<SUBSECTION Standard>
@ -376,18 +377,11 @@ GES_TRACK_TITLE_SOURCE_GET_CLASS
GES_TYPE_TRACK_TITLE_SOURCE
</SECTION>
<SECTION>
<FILE>ges-track-video-background-source</FILE>
<TITLE>GESTrackVideoBackgroundSource</TITLE>
GESTrackVideoBackgroundSource
GESTrackVideoBackgroundSourceClass
GESTrackVideoBgSrcPattern
<SUBSECTION Standard>
</SECTION>
<SECTION>
<FILE>ges-track-audio-background-source</FILE>
<TITLE>GESTrackAudioBackgroundSource</TITLE>
GESTrackAudioBackgroundSource
GESTrackAudioBackgroundSourceClass
ges_track_audio_background_source_new
ges_track_abg_src_get_type
ges_track_video_title_source_new

2
ges/ges-timeline-background-source.c
View file

@ -19,7 +19,7 @@
*/
/**
* SECTION:ges-timeline-backgroundsource
* SECTION:ges-timeline-background-source
* @short_description: An object for manipulating media files in a GESTimeline
*
* Represents all the output treams from a particular uri. It is assumed that

5
ges/ges-timeline-background-source.h
View file

@ -46,15 +46,16 @@ G_BEGIN_DECLS
(G_TYPE_INSTANCE_GET_CLASS ((obj), GES_TYPE_TIMELINE_BACKGROUND_SOURCE, GESTimelineBackgroundSourceClass))
/**
* GESTimelineSource:
* GESTimelineBackgroundSource:
* @parent: parent
*
*/
struct _GESTimelineBackgroundSource {
GESTimelineSource parent;
gboolean mute;
/*< private >*/
gboolean mute;
gint vpattern;
};

2
ges/ges-timeline-title-source.c
View file

@ -19,7 +19,7 @@
*/
/**
* SECTION:ges-timeline-titlesource
* SECTION:ges-timeline-title-source
* @short_description: An object for manipulating media files in a GESTimeline
*
* Represents all the output treams from a particular uri. It is assumed that

3
ges/ges-timeline-title-source.h
View file

@ -46,7 +46,8 @@ G_BEGIN_DECLS
(G_TYPE_INSTANCE_GET_CLASS ((obj), GES_TYPE_TIMELINE_TITLE_SOURCE, GESTimelineTitleSourceClass))
/**
* GESTimelineSource:
* GESTimelineTitleSource:
* @parent: parent
*
*/

2
ges/ges-timeline-transition.c
View file

@ -120,7 +120,7 @@ ges_timeline_transition_class_init (GESTimelineTransitionClass * klass)
object_class->finalize = ges_timeline_transition_finalize;
/**
* GESTimelineTransition: vtype
* GESTimelineTransition:vtype
*
* The SMPTE wipe to use, or 0 for crossfade.
*/

2
ges/ges-track-audio-background-source.c
View file

@ -19,7 +19,7 @@
*/
/**
* SECTION:ges-track-source
* SECTION:ges-track-audio-background-source
* @short_description: Base Class for single-media sources
*/

7
ges/ges-track-audio-background-source.h
View file

@ -43,11 +43,13 @@ G_BEGIN_DECLS
#define GES_TRACK_AUDIO_BACKGROUND_SOURCE_GET_CLASS(obj) \
(G_TYPE_INSTANCE_GET_CLASS ((obj), GES_TYPE_TRACK_AUDIO_BACKGROUND_SOURCE, GESTrackAudioBackgroundSourceClass))
/**
* GESTrackAudioBackgroundSource:
* @uri: #gchar *, the URI of the media audio_background to play
* @parent: parent
*
*/
struct _GESTrackAudioBackgroundSource {
GESTrackBackgroundSource parent;
@ -57,12 +59,13 @@ struct _GESTrackAudioBackgroundSource {
/**
* GESTrackAudioBackgroundSourceClass:
* @parent_class: parent class
*
*/
struct _GESTrackAudioBackgroundSourceClass {
GESTrackBackgroundSourceClass parent_class;
/* <public> */
/*< public >*/
};
GType ges_track_abg_src_get_type (void);

4
ges/ges-track-background-source.c
View file

@ -19,8 +19,8 @@
*/
/**
* SECTION:ges-track-source
* @short_description: Base Class for single-media sources
* SECTION:ges-track-background-source
* @short_description: Base Class for background source track objects
*/
#include "ges-internal.h"

6
ges/ges-track-background-source.h
View file

@ -46,13 +46,13 @@ G_BEGIN_DECLS
(G_TYPE_INSTANCE_GET_CLASS ((obj), GES_TYPE_TRACK_BACKGROUND_SOURCE, GESTrackBackgroundSourceClass))
/**
* GESTrackBackgroundSource:
* @uri: #gchar *, the URI of the media file to play
* @parent: parent
*
*/
struct _GESTrackBackgroundSource {
GESTrackSource parent;
/*< public >*/
/*< private >*/
GstElement *element;
};
@ -64,7 +64,7 @@ struct _GESTrackBackgroundSource {
struct _GESTrackBackgroundSourceClass {
GESTrackSourceClass parent_class;
/* <public> */
/*< public >*/
GstElement* (*create_element) (GESTrackBackgroundSource *obj);
};

2
ges/ges-track-title-source.c
View file

@ -19,7 +19,7 @@
*/
/**
* SECTION:ges-track-source
* SECTION:ges-track-title-source
* @short_description: Base Class for single-media sources
*/

2
ges/ges-track-title-source.h
View file

@ -46,7 +46,7 @@ G_BEGIN_DECLS
(G_TYPE_INSTANCE_GET_CLASS ((obj), GES_TYPE_TRACK_TITLE_SOURCE, GESTrackTitleSourceClass))
/**
* GESTrackTitleSource:
* @uri: #gchar *, the URI of the media file to play
* @parent: parent
*
*/
struct _GESTrackTitleSource {

4
ges/ges-track-video-background-source.c
View file

@ -19,8 +19,8 @@
*/
/**
* SECTION:ges-track-source
* @short_description: Base Class for single-media sources
* SECTION:ges-track-video-background-source
* @short_description: implements solid colors and patterns with videotestsrc
*/
#include "ges-internal.h"

23
ges/ges-track-video-background-source.h
View file

@ -44,6 +44,26 @@ G_BEGIN_DECLS
#define GES_TRACK_VIDEO_BACKGROUND_SOURCE_GET_CLASS(obj) \
(G_TYPE_INSTANCE_GET_CLASS ((obj), GES_TYPE_TRACK_VIDEO_BACKGROUND_SOURCE, GESTrackVideoBackgroundSourceClass))
/**$
* GESTrackVideoBgSrcPattern:$
* @GES_TRACK_VIDEO_BG_SRC_SMPTE: A standard SMPTE test pattern$
* @GES_TRACK_VIDEO_BG_SRC_SNOW: Random noise$
* @GES_TRACK_VIDEO_BG_SRC_BLACK: A black image$
* @GES_TRACK_VIDEO_BG_SRC_WHITE: A white image$
* @GES_TRACK_VIDEO_BG_SRC_RED: A red image$
* @GES_TRACK_VIDEO_BG_SRC_GREEN: A green image$
* @GES_TRACK_VIDEO_BG_SRC_BLUE: A blue image$
* @GES_TRACK_VIDEO_BG_SRC_CHECKERS1: Checkers pattern (1px)$
* @GES_TRACK_VIDEO_BG_SRC_CHECKERS2: Checkers pattern (2px)$
* @GES_TRACK_VIDEO_BG_SRC_CHECKERS4: Checkers pattern (4px)$
* @GES_TRACK_VIDEO_BG_SRC_CHECKERS8: Checkers pattern (8px)$
* @GES_TRACK_VIDEO_BG_SRC_CIRCULAR: Circular pattern$
* @GES_TRACK_VIDEO_BG_SRC_BLINK: Alternate between black and white$
* @GES_TRACK_VIDEO_BG_SRC_SMPTE75: SMPTE test pattern (75% color bars)$
*
*/
typedef enum {
GES_TRACK_VIDEO_BG_SRC_SMPTE,
GES_TRACK_VIDEO_BG_SRC_SNOW,
@ -63,8 +83,7 @@ typedef enum {
/**
* GESTrackVideoBackgroundSource:
* @uri: #gchar *, the URI of the media video_background to play
*
* @parent: parent
*/
struct _GESTrackVideoBackgroundSource {
GESTrackBackgroundSource parent;