[gtk+] [docs] Fix GtkOffscreenWindow documentation
- From: Javier Jardón <jjardon src gnome org>
- To: svn-commits-list gnome org
- Cc:
- Subject: [gtk+] [docs] Fix GtkOffscreenWindow documentation
- Date: Thu, 28 Jan 2010 03:11:17 +0000 (UTC)
commit cc62ab3a0cf52aa5850c6ea733a07326327da03a
Author: Javier Jardón <jjardon gnome org>
Date: Thu Jan 28 03:10:09 2010 +0100
[docs] Fix GtkOffscreenWindow documentation
docs/reference/gtk/gtk-docs.sgml | 1 +
docs/reference/gtk/gtk.types | 1 +
gtk/gtkoffscreenwindow.c | 16 +++++++++-------
3 files changed, 11 insertions(+), 7 deletions(-)
---
diff --git a/docs/reference/gtk/gtk-docs.sgml b/docs/reference/gtk/gtk-docs.sgml
index dc31b1a..0c50347 100644
--- a/docs/reference/gtk/gtk-docs.sgml
+++ b/docs/reference/gtk/gtk-docs.sgml
@@ -150,6 +150,7 @@ that is, GUI components such as #GtkButton or #GtkTextView.
<xi:include href="xml/gtkwindowgroup.xml" />
<xi:include href="xml/gtkaboutdialog.xml" />
<xi:include href="xml/gtkassistant.xml" />
+ <xi:include href="xml/gtkoffscreenwindow.xml" />
</chapter>
<chapter id="DisplayWidgets">
diff --git a/docs/reference/gtk/gtk.types b/docs/reference/gtk/gtk.types
index 39c475c..1faa1f0 100644
--- a/docs/reference/gtk/gtk.types
+++ b/docs/reference/gtk/gtk.types
@@ -104,6 +104,7 @@ gtk_misc_get_type
gtk_mount_operation_get_type
gtk_notebook_get_type
gtk_object_get_type
+gtk_offscreen_window_get_type
gtk_old_editable_get_type
gtk_option_menu_get_type
gtk_orientable_get_type
diff --git a/gtk/gtkoffscreenwindow.c b/gtk/gtkoffscreenwindow.c
index 98034c6..840995e 100644
--- a/gtk/gtkoffscreenwindow.c
+++ b/gtk/gtkoffscreenwindow.c
@@ -22,10 +22,10 @@
#include "gtkalias.h"
/**
- * SECTION:offscreen_windows
- * @short description: A toplevel container widget used to manage offscreen
+ * SECTION:gtkoffscreenwindow
+ * @short_description: A toplevel container widget used to manage offscreen
* rendering of child widgets.
- * @title: Offscreen windows
+ * @title: GtkOffscreenWindow
*
* #GtkOffscreenWindow is strictly intended to be used for obtaining
* snapshots of widgets that are not part of a normal widget hierarchy.
@@ -45,7 +45,7 @@
* has no parent widget.
*
* When contained offscreen widgets are redrawn, #GtkOffscreenWindow
- * will emit a "damage-event" signal.
+ * will emit a #GtkWidget::damage-event signal.
*/
G_DEFINE_TYPE (GtkOffscreenWindow, gtk_offscreen_window, GTK_TYPE_WINDOW);
@@ -249,7 +249,7 @@ gtk_offscreen_window_init (GtkOffscreenWindow *window)
* Return value: A pointer to a #GtkWidget
*
* Since: 2.20
- **/
+ */
GtkWidget *
gtk_offscreen_window_new (void)
{
@@ -258,6 +258,7 @@ gtk_offscreen_window_new (void)
/**
* gtk_offscreen_window_get_pixmap:
+ * @offscreen: the #GtkOffscreenWindow contained widget.
*
* Retrieves a snapshot of the contained widget in the form of
* a #GdkPixmap. If you need to keep this around over window
@@ -266,7 +267,7 @@ gtk_offscreen_window_new (void)
* Returns: A #GdkPixmap pointer to the offscreen pixmap, or %NULL.
*
* Since: 2.20
- **/
+ */
GdkPixmap *
gtk_offscreen_window_get_pixmap (GtkOffscreenWindow *offscreen)
{
@@ -277,6 +278,7 @@ gtk_offscreen_window_get_pixmap (GtkOffscreenWindow *offscreen)
/**
* gtk_offscreen_window_get_pixbuf:
+ * @offscreen: the #GtkOffscreenWindow contained widget.
*
* Retrieves a snapshot of the contained widget in the form of
* a #GdkPixbuf. This is a new pixbuf with a reference count of 1,
@@ -286,7 +288,7 @@ gtk_offscreen_window_get_pixmap (GtkOffscreenWindow *offscreen)
* Returns: A #GdkPixbuf pointer, or %NULL.
*
* Since: 2.20
- **/
+ */
GdkPixbuf *
gtk_offscreen_window_get_pixbuf (GtkOffscreenWindow *offscreen)
{
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]