[totem] docs: Add documentation strings to properties on GObjects
- From: Philip Withnall <pwithnall src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [totem] docs: Add documentation strings to properties on GObjects
- Date: Tue, 5 Jul 2011 20:20:51 +0000 (UTC)
commit aee1a5cc2d6105db1312a25b4bfc961ca48e3807
Author: Philip Withnall <philip tecnocode co uk>
Date: Tue Jul 5 20:42:11 2011 +0100
docs: Add documentation strings to properties on GObjects
This makes gtk-doc happy, and we all want to make gtk-doc happy.
src/backend/bacon-video-widget-gst-0.10.c | 70 ++++++++++++++--------------
src/totem-cell-renderer-video.c | 9 ++--
src/totem-object.c | 18 ++++---
src/totem-video-list.c | 9 ++--
4 files changed, 55 insertions(+), 51 deletions(-)
---
diff --git a/src/backend/bacon-video-widget-gst-0.10.c b/src/backend/bacon-video-widget-gst-0.10.c
index df1c83f..e616cc3 100644
--- a/src/backend/bacon-video-widget-gst-0.10.c
+++ b/src/backend/bacon-video-widget-gst-0.10.c
@@ -771,8 +771,8 @@ bacon_video_widget_class_init (BaconVideoWidgetClass * klass)
* should take up no space.
**/
g_object_class_install_property (object_class, PROP_LOGO_MODE,
- g_param_spec_boolean ("logo-mode", NULL,
- NULL, FALSE,
+ g_param_spec_boolean ("logo-mode", "Logo mode?",
+ "Whether the logo should be displayed when no stream is loaded.", FALSE,
G_PARAM_READWRITE |
G_PARAM_STATIC_STRINGS));
@@ -782,7 +782,7 @@ bacon_video_widget_class_init (BaconVideoWidgetClass * klass)
* The current position in the stream, as a percentage between <code class="literal">0</code> and <code class="literal">1</code>.
**/
g_object_class_install_property (object_class, PROP_POSITION,
- g_param_spec_double ("position", NULL, NULL,
+ g_param_spec_double ("position", "Position", "The current position in the stream.",
0, 1.0, 0,
G_PARAM_READABLE |
G_PARAM_STATIC_STRINGS));
@@ -793,8 +793,8 @@ bacon_video_widget_class_init (BaconVideoWidgetClass * klass)
* The length of the current stream, in milliseconds.
**/
g_object_class_install_property (object_class, PROP_STREAM_LENGTH,
- g_param_spec_int64 ("stream-length", NULL,
- NULL, 0, G_MAXINT64, 0,
+ g_param_spec_int64 ("stream-length", "Stream length",
+ "The length of the current stream, in milliseconds.", 0, G_MAXINT64, 0,
G_PARAM_READABLE |
G_PARAM_STATIC_STRINGS));
@@ -804,8 +804,8 @@ bacon_video_widget_class_init (BaconVideoWidgetClass * klass)
* Whether a stream is currently playing.
**/
g_object_class_install_property (object_class, PROP_PLAYING,
- g_param_spec_boolean ("playing", NULL,
- NULL, FALSE,
+ g_param_spec_boolean ("playing", "Playing?",
+ "Whether a stream is currently playing.", FALSE,
G_PARAM_READABLE |
G_PARAM_STATIC_STRINGS));
@@ -815,8 +815,8 @@ bacon_video_widget_class_init (BaconVideoWidgetClass * klass)
* Whether the current stream can be seeked.
**/
g_object_class_install_property (object_class, PROP_SEEKABLE,
- g_param_spec_boolean ("seekable", NULL,
- NULL, FALSE,
+ g_param_spec_boolean ("seekable", "Seekable?",
+ "Whether the current stream can be seeked.", FALSE,
G_PARAM_READABLE |
G_PARAM_STATIC_STRINGS));
@@ -826,7 +826,7 @@ bacon_video_widget_class_init (BaconVideoWidgetClass * klass)
* The current volume level, as a percentage between <code class="literal">0</code> and <code class="literal">1</code>.
**/
g_object_class_install_property (object_class, PROP_VOLUME,
- g_param_spec_double ("volume", NULL, NULL,
+ g_param_spec_double ("volume", "Volume", "The current volume level.",
0.0, 1.0, 0.0,
G_PARAM_READWRITE |
G_PARAM_STATIC_STRINGS));
@@ -838,8 +838,8 @@ bacon_video_widget_class_init (BaconVideoWidgetClass * klass)
* the video widget.
**/
g_object_class_install_property (object_class, PROP_SHOW_CURSOR,
- g_param_spec_boolean ("show-cursor", NULL,
- NULL, FALSE,
+ g_param_spec_boolean ("show-cursor", "Show cursor?",
+ "Whether the cursor should be shown.", FALSE,
G_PARAM_READWRITE |
G_PARAM_STATIC_STRINGS));
@@ -849,8 +849,8 @@ bacon_video_widget_class_init (BaconVideoWidgetClass * klass)
* Whether visualisations should be shown for audio-only streams.
**/
g_object_class_install_property (object_class, PROP_SHOW_VISUALIZATIONS,
- g_param_spec_boolean ("show-visualizations", NULL,
- NULL, FALSE,
+ g_param_spec_boolean ("show-visualizations", "Show visualizations?",
+ "Whether visualisations should be shown for audio-only streams.", FALSE,
G_PARAM_WRITABLE |
G_PARAM_STATIC_STRINGS));
@@ -860,7 +860,7 @@ bacon_video_widget_class_init (BaconVideoWidgetClass * klass)
* The HTTP referrer URI.
**/
g_object_class_install_property (object_class, PROP_USER_AGENT,
- g_param_spec_string ("referrer", NULL, NULL,
+ g_param_spec_string ("referrer", "Referrer URI", "The HTTP referrer URI.",
NULL,
G_PARAM_READWRITE |
G_PARAM_STATIC_STRINGS));
@@ -871,7 +871,7 @@ bacon_video_widget_class_init (BaconVideoWidgetClass * klass)
* The HTTP user agent string to use.
**/
g_object_class_install_property (object_class, PROP_USER_AGENT,
- g_param_spec_string ("user-agent", NULL, NULL,
+ g_param_spec_string ("user-agent", "User agent", "The HTTP user agent string to use.",
NULL,
G_PARAM_READWRITE |
G_PARAM_STATIC_STRINGS));
@@ -883,7 +883,7 @@ bacon_video_widget_class_init (BaconVideoWidgetClass * klass)
* download buffering.
**/
g_object_class_install_property (object_class, PROP_DOWNLOAD_FILENAME,
- g_param_spec_string ("download-filename", NULL, NULL,
+ g_param_spec_string ("download-filename", "Download filename.", "The filename of the fully downloaded stream.",
NULL,
G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
@@ -893,8 +893,8 @@ bacon_video_widget_class_init (BaconVideoWidgetClass * klass)
* Whether to automatically resize the video widget to the video size when loading a new video.
**/
g_object_class_install_property (object_class, PROP_AUTO_RESIZE,
- g_param_spec_boolean ("auto-resize", NULL,
- NULL, FALSE,
+ g_param_spec_boolean ("auto-resize", "Auto resize?",
+ "Whether to automatically resize the video widget to the video size.", FALSE,
G_PARAM_READWRITE |
G_PARAM_STATIC_STRINGS));
@@ -904,8 +904,8 @@ bacon_video_widget_class_init (BaconVideoWidgetClass * klass)
* Whether to automatically deinterlace videos.
**/
g_object_class_install_property (object_class, PROP_DEINTERLACING,
- g_param_spec_boolean ("deinterlacing", NULL,
- NULL, FALSE,
+ g_param_spec_boolean ("deinterlacing", "Deinterlacing?",
+ "Whether to automatically deinterlace videos.", FALSE,
G_PARAM_READWRITE |
G_PARAM_STATIC_STRINGS));
@@ -915,8 +915,8 @@ bacon_video_widget_class_init (BaconVideoWidgetClass * klass)
* The connection speed to use when calculating how much of a network stream to buffer.
**/
g_object_class_install_property (object_class, PROP_CONNECTION_SPEED,
- g_param_spec_enum ("connection-speed", NULL,
- NULL, BVW_TYPE_CONNECTION_SPEED,
+ g_param_spec_enum ("connection-speed", "Connection speed",
+ "The connection speed to use in calculating buffering streams.", BVW_TYPE_CONNECTION_SPEED,
BVW_SPEED_LAN,
G_PARAM_READWRITE |
G_PARAM_STATIC_STRINGS));
@@ -927,8 +927,8 @@ bacon_video_widget_class_init (BaconVideoWidgetClass * klass)
* The size of the visualizations to display when playing audio.
**/
g_object_class_install_property (object_class, PROP_VISUALIZATION_QUALITY,
- g_param_spec_enum ("visualization-quality", NULL,
- NULL, BVW_TYPE_VISUALIZATION_QUALITY,
+ g_param_spec_enum ("visualization-quality", "Visualization quality",
+ "The size of the visualizations to display when playing audio.", BVW_TYPE_VISUALIZATION_QUALITY,
BVW_VISUALIZATION_SMALL,
G_PARAM_READWRITE |
G_PARAM_STATIC_STRINGS));
@@ -939,8 +939,8 @@ bacon_video_widget_class_init (BaconVideoWidgetClass * klass)
* The brightness of the video display.
**/
g_object_class_install_property (object_class, PROP_BRIGHTNESS,
- g_param_spec_int ("brightness", NULL,
- NULL, 0, 65535, 32768,
+ g_param_spec_int ("brightness", "Brightness",
+ "The brightness of the video display.", 0, 65535, 32768,
G_PARAM_READWRITE |
G_PARAM_STATIC_STRINGS));
@@ -950,8 +950,8 @@ bacon_video_widget_class_init (BaconVideoWidgetClass * klass)
* The contrast of the video display.
**/
g_object_class_install_property (object_class, PROP_CONTRAST,
- g_param_spec_int ("contrast", NULL,
- NULL, 0, 65535, 32768,
+ g_param_spec_int ("contrast", "Contrast",
+ "The contrast of the video display.", 0, 65535, 32768,
G_PARAM_READWRITE |
G_PARAM_STATIC_STRINGS));
@@ -961,8 +961,8 @@ bacon_video_widget_class_init (BaconVideoWidgetClass * klass)
* The saturation of the video display.
**/
g_object_class_install_property (object_class, PROP_SATURATION,
- g_param_spec_int ("saturation", NULL,
- NULL, 0, 65535, 32768,
+ g_param_spec_int ("saturation", "Saturation",
+ "The saturation of the video display.", 0, 65535, 32768,
G_PARAM_READWRITE |
G_PARAM_STATIC_STRINGS));
@@ -972,8 +972,8 @@ bacon_video_widget_class_init (BaconVideoWidgetClass * klass)
* The hue of the video display.
**/
g_object_class_install_property (object_class, PROP_HUE,
- g_param_spec_int ("hue", NULL,
- NULL, 0, 65535, 32768,
+ g_param_spec_int ("hue", "Hue",
+ "The hue of the video display.", 0, 65535, 32768,
G_PARAM_READWRITE |
G_PARAM_STATIC_STRINGS));
@@ -983,8 +983,8 @@ bacon_video_widget_class_init (BaconVideoWidgetClass * klass)
* The type of audio output to use (e.g. the number of channels).
**/
g_object_class_install_property (object_class, PROP_AUDIO_OUTPUT_TYPE,
- g_param_spec_enum ("audio-output-type", NULL,
- NULL, BVW_TYPE_AUDIO_OUTPUT_TYPE,
+ g_param_spec_enum ("audio-output-type", "Audio output type",
+ "The type of audio output to use.", BVW_TYPE_AUDIO_OUTPUT_TYPE,
BVW_AUDIO_SOUND_STEREO,
G_PARAM_READWRITE |
G_PARAM_STATIC_STRINGS));
diff --git a/src/totem-cell-renderer-video.c b/src/totem-cell-renderer-video.c
index 10821b6..3f0d596 100644
--- a/src/totem-cell-renderer-video.c
+++ b/src/totem-cell-renderer-video.c
@@ -113,7 +113,7 @@ totem_cell_renderer_video_class_init (TotemCellRendererVideoClass *klass)
* so can be as large as reasonable.
**/
g_object_class_install_property (object_class, PROP_THUMBNAIL,
- g_param_spec_object ("thumbnail", NULL, NULL,
+ g_param_spec_object ("thumbnail", "Thumbnail", "A GdkPixbuf of a thumbnail of the video to display.",
GDK_TYPE_PIXBUF, G_PARAM_READWRITE));
/**
@@ -122,7 +122,7 @@ totem_cell_renderer_video_class_init (TotemCellRendererVideoClass *klass)
* The title of the video, as it should be displayed.
**/
g_object_class_install_property (object_class, PROP_TITLE,
- g_param_spec_string ("title", NULL, NULL,
+ g_param_spec_string ("title", "Title", "The title of the video, as it should be displayed.",
_("Unknown video"), G_PARAM_READWRITE));
/**
@@ -131,7 +131,7 @@ totem_cell_renderer_video_class_init (TotemCellRendererVideoClass *klass)
* A #PangoAlignment giving the text alignment for the video title.
**/
g_object_class_install_property (object_class, PROP_ALIGNMENT,
- g_param_spec_enum ("alignment", NULL, NULL,
+ g_param_spec_enum ("alignment", "Alignment", "A PangoAlignment giving the text alignment for the video title.",
PANGO_TYPE_ALIGNMENT,
PANGO_ALIGN_CENTER,
G_PARAM_READWRITE));
@@ -142,7 +142,8 @@ totem_cell_renderer_video_class_init (TotemCellRendererVideoClass *klass)
* If %TRUE, a placeholder image should be used for the video thumbnail if a #TotemCellRendererVideo:thumbnail isn't provided.
**/
g_object_class_install_property (object_class, PROP_USE_PLACEHOLDER,
- g_param_spec_boolean ("use-placeholder", NULL, NULL,
+ g_param_spec_boolean ("use-placeholder", "Use placeholder?",
+ "Whether a placeholder image should be used for the video thumbnail.",
FALSE, G_PARAM_READWRITE));
}
diff --git a/src/totem-object.c b/src/totem-object.c
index e7d7d03..f91fe67 100644
--- a/src/totem-object.c
+++ b/src/totem-object.c
@@ -159,7 +159,7 @@ totem_object_class_init (TotemObjectClass *klass)
* If %TRUE, Totem is in fullscreen mode.
**/
g_object_class_install_property (object_class, PROP_FULLSCREEN,
- g_param_spec_boolean ("fullscreen", NULL, NULL,
+ g_param_spec_boolean ("fullscreen", "Fullscreen?", "Whether Totem is in fullscreen mode.",
FALSE, G_PARAM_READABLE));
/**
@@ -168,7 +168,7 @@ totem_object_class_init (TotemObjectClass *klass)
* If %TRUE, Totem is playing an audio or video file.
**/
g_object_class_install_property (object_class, PROP_PLAYING,
- g_param_spec_boolean ("playing", NULL, NULL,
+ g_param_spec_boolean ("playing", "Playing?", "Whether Totem is currently playing a file.",
FALSE, G_PARAM_READABLE));
/**
@@ -177,7 +177,7 @@ totem_object_class_init (TotemObjectClass *klass)
* The length of the current stream, in milliseconds.
**/
g_object_class_install_property (object_class, PROP_STREAM_LENGTH,
- g_param_spec_int64 ("stream-length", NULL, NULL,
+ g_param_spec_int64 ("stream-length", "Stream length", "The length of the current stream.",
G_MININT64, G_MAXINT64, 0,
G_PARAM_READABLE));
@@ -187,7 +187,7 @@ totem_object_class_init (TotemObjectClass *klass)
* The player's position (time) in the current stream, in milliseconds.
**/
g_object_class_install_property (object_class, PROP_CURRENT_TIME,
- g_param_spec_int64 ("current-time", NULL, NULL,
+ g_param_spec_int64 ("current-time", "Current time", "The player's position (time) in the current stream.",
G_MININT64, G_MAXINT64, 0,
G_PARAM_READABLE));
@@ -197,7 +197,7 @@ totem_object_class_init (TotemObjectClass *klass)
* If %TRUE, the current stream is seekable.
**/
g_object_class_install_property (object_class, PROP_SEEKABLE,
- g_param_spec_boolean ("seekable", NULL, NULL,
+ g_param_spec_boolean ("seekable", "Seekable?", "Whether the current stream is seekable.",
FALSE, G_PARAM_READABLE));
/**
@@ -206,7 +206,7 @@ totem_object_class_init (TotemObjectClass *klass)
* The MRL of the current stream.
**/
g_object_class_install_property (object_class, PROP_CURRENT_MRL,
- g_param_spec_string ("current-mrl", NULL, NULL,
+ g_param_spec_string ("current-mrl", "Current MRL", "The MRL of the current stream.",
NULL, G_PARAM_READABLE));
/**
@@ -215,7 +215,8 @@ totem_object_class_init (TotemObjectClass *klass)
* If %TRUE, Totem will automatically load any subtitle files it finds for each newly opened video.
**/
g_object_class_install_property (object_class, PROP_AUTOLOAD_SUBTITLES,
- g_param_spec_boolean ("autoload-subtitles", NULL, NULL,
+ g_param_spec_boolean ("autoload-subtitles", "Autoload subtitles?",
+ "Whether to automatically load any subtitle files Totem finds.",
FALSE, G_PARAM_READWRITE));
/**
@@ -224,7 +225,8 @@ totem_object_class_init (TotemObjectClass *klass)
* If %TRUE, Totem will remember the position it was at last time a given file was opened.
**/
g_object_class_install_property (object_class, PROP_REMEMBER_POSITION,
- g_param_spec_boolean ("remember-position", NULL, NULL,
+ g_param_spec_boolean ("remember-position", "Remember position?",
+ "Whether to remember the position each video was at last time.",
FALSE, G_PARAM_READWRITE));
/**
diff --git a/src/totem-video-list.c b/src/totem-video-list.c
index caa4295..fbdceea 100644
--- a/src/totem-video-list.c
+++ b/src/totem-video-list.c
@@ -134,7 +134,7 @@ totem_video_list_class_init (TotemVideoListClass *klass)
* If it's set to -1, no tooltips shall be displayed.
**/
g_object_class_install_property (object_class, PROP_TOOLTIP_COLUMN,
- g_param_spec_int ("tooltip-column", NULL, NULL,
+ g_param_spec_int ("tooltip-column", "Tooltip column", "The column number of the column containing tooltips.",
-1, G_MAXINT, -1, G_PARAM_READWRITE));
/**
@@ -144,7 +144,7 @@ totem_video_list_class_init (TotemVideoListClass *klass)
* If it's set to -1, video rows will not be activatable (e.g. by double-clicking them).
**/
g_object_class_install_property (object_class, PROP_MRL_COLUMN,
- g_param_spec_int ("mrl-column", NULL, NULL,
+ g_param_spec_int ("mrl-column", "MRL column", "The column number of the column containing MRLs of the videos.",
-1, G_MAXINT, -1, G_PARAM_READWRITE));
/**
@@ -154,7 +154,7 @@ totem_video_list_class_init (TotemVideoListClass *klass)
**/
/* FIXME: Is there no better way to do this? */
g_object_class_install_property (object_class, PROP_TOTEM,
- g_param_spec_object ("totem", NULL, NULL,
+ g_param_spec_object ("totem", "Totem", "A TotemObject for integration purposes.",
TOTEM_TYPE_OBJECT, G_PARAM_READWRITE));
/**
@@ -166,7 +166,8 @@ totem_video_list_class_init (TotemVideoListClass *klass)
* Since: 2.90.6
**/
g_object_class_install_property (object_class, PROP_SHOW_TOOLTIP_URI,
- g_param_spec_boolean ("show-tooltip-uri", NULL, NULL,
+ g_param_spec_boolean ("show-tooltip-uri", "Show tooltip URI?",
+ "Whether the URI of each video will be displayed in the tooltip for that video.",
TRUE, G_PARAM_READWRITE));
/**
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]
