summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorMatthias Clasen <matthiasc@src.gnome.org>2007-06-11 03:41:27 +0000
committerMatthias Clasen <matthiasc@src.gnome.org>2007-06-11 03:41:27 +0000
commit780c39c358acb90489b24a2c49432ad11d5c9a59 (patch)
tree7cc33c320b3a83196a86a89aebdad235f22fe0f9 /docs
parent9b8d335adeac6c9e7c58a736d3dd39627ead02dd (diff)
downloadgdk-pixbuf-780c39c358acb90489b24a2c49432ad11d5c9a59.tar.gz
Clean up short descriptions
svn path=/trunk/; revision=18098
Diffstat (limited to 'docs')
-rw-r--r--docs/reference/ChangeLog27
-rw-r--r--docs/reference/gtk/gtk-update-icon-cache.xml8
-rw-r--r--docs/reference/gtk/text_widget.sgml2
-rw-r--r--docs/reference/gtk/tmpl/gtkbbox.sgml2
-rw-r--r--docs/reference/gtk/tmpl/gtkcellrenderer.sgml2
-rw-r--r--docs/reference/gtk/tmpl/gtkgamma.sgml2
-rw-r--r--docs/reference/gtk/tmpl/gtkhruler.sgml2
-rw-r--r--docs/reference/gtk/tmpl/gtkliststore.sgml14
-rw-r--r--docs/reference/gtk/tmpl/gtkmenubar.sgml2
-rw-r--r--docs/reference/gtk/tmpl/gtkrecentchooser.sgml52
-rw-r--r--docs/reference/gtk/tmpl/gtkscalebutton.sgml7
-rw-r--r--docs/reference/gtk/tmpl/gtkseparator.sgml2
-rw-r--r--docs/reference/gtk/tmpl/gtktextbuffer.sgml4
-rw-r--r--docs/reference/gtk/tmpl/gtktexttag.sgml3
-rw-r--r--docs/reference/gtk/tmpl/gtktextview.sgml2
-rw-r--r--docs/reference/gtk/tmpl/gtktreemodel.sgml2
-rw-r--r--docs/reference/gtk/tmpl/gtktreeselection.sgml2
-rw-r--r--docs/reference/gtk/tmpl/gtktreestore.sgml14
-rw-r--r--docs/reference/gtk/tmpl/gtktreeviewcolumn.sgml11
-rw-r--r--docs/reference/gtk/tmpl/gtkvolumebutton.sgml2
-rw-r--r--docs/reference/gtk/tmpl/gtkvruler.sgml2
-rw-r--r--docs/reference/gtk/tree_widget.sgml3
22 files changed, 143 insertions, 24 deletions
diff --git a/docs/reference/ChangeLog b/docs/reference/ChangeLog
index 3c588e06b..50fa1e023 100644
--- a/docs/reference/ChangeLog
+++ b/docs/reference/ChangeLog
@@ -1,5 +1,32 @@
2007-06-09 Matthias Clasen <mclasen@redhat.com>
+ * gtk/gtk-update-icon-cache.xml: Document --validate
+
+2007-06-09 Matthias Clasen <mclasen@redhat.com>
+
+ * gtk/text_widget.sgml:
+ * gtk/tree_widget.sgml:
+ * gtk/tmpl/gtkscalebutton.sgml:
+ * gtk/tmpl/gtktextbuffer.sgml:
+ * gtk/tmpl/gtktexttag.sgml:
+ * gtk/tmpl/gtktextview.sgml:
+ * gtk/tmpl/gtktreemodel.sgml:
+ * gtk/tmpl/gtktreeselection.sgml:
+ * gtk/tmpl/gtktreeviewcolumn.sgml:
+ * gtk/tmpl/gtkcellrenderer.sgml:
+ * gtk/tmpl/gtkliststore.sgml:
+ * gtk/tmpl/gtktreestore.sgml:
+ * gtk/tmpl/gtkmenubar.sgml:
+ * gtk/tmpl/gtkbbox.sgml:
+ * gtk/tmpl/gtkseparator.sgml:
+ * gtk/tmpl/gtkgamma.sgml:
+ * gtk/tmpl/gtkhruler.sgml:
+ * gtk/tmpl/gtkvruler.sgml:
+ * gtk/tmpl/gtkrecentchooser.sgml:
+ * gtk/tmpl/gtkvolumebutton.sgml: Clean up short descriptions
+
+2007-06-09 Matthias Clasen <mclasen@redhat.com>
+
* gtk/tmpl/gtkbindings.sgml:
* gtk/tmpl/gtkrc.sgml:
* gtk/tmpl/gtkwidget.sgml:
diff --git a/docs/reference/gtk/gtk-update-icon-cache.xml b/docs/reference/gtk/gtk-update-icon-cache.xml
index 6568d5d5f..58c5a28a8 100644
--- a/docs/reference/gtk/gtk-update-icon-cache.xml
+++ b/docs/reference/gtk/gtk-update-icon-cache.xml
@@ -18,6 +18,7 @@
<arg choice="opt">--index-only</arg>
<arg choice="opt">--source<arg>name</arg></arg>
<arg choice="opt">--quiet</arg>
+<arg choice="opt">--validate</arg>
<arg choice="req">iconpath</arg>
</cmdsynopsis>
</refsynopsisdiv>
@@ -80,6 +81,13 @@ multiple applications, the overall memory consumption is reduced as well.
<listitem><para>Turn off verbose output.
</para></listitem>
</varlistentry>
+
+ <varlistentry>
+ <term>--validate</term>
+ <term>-v</term>
+ <listitem><para>Validate existing icon cache.
+ </para></listitem>
+ </varlistentry>
</variablelist>
</refsect1>
diff --git a/docs/reference/gtk/text_widget.sgml b/docs/reference/gtk/text_widget.sgml
index da31a8ee1..2e7d3c308 100644
--- a/docs/reference/gtk/text_widget.sgml
+++ b/docs/reference/gtk/text_widget.sgml
@@ -7,7 +7,7 @@
<refnamediv>
<refname>Text Widget Overview</refname>
-<refpurpose>Overview of #GtkTextBuffer, #GtkTextView, and friends</refpurpose>
+<refpurpose>Overview of GtkTextBuffer, GtkTextView, and friends</refpurpose>
</refnamediv>
<refsect1>
diff --git a/docs/reference/gtk/tmpl/gtkbbox.sgml b/docs/reference/gtk/tmpl/gtkbbox.sgml
index 4037e3b15..53dcbb99a 100644
--- a/docs/reference/gtk/tmpl/gtkbbox.sgml
+++ b/docs/reference/gtk/tmpl/gtkbbox.sgml
@@ -2,7 +2,7 @@
GtkButtonBox
<!-- ##### SECTION Short_Description ##### -->
-Base class for #GtkHButtonBox and #GtkVButtonBox
+Base class for GtkHButtonBox and GtkVButtonBox
<!-- ##### SECTION Long_Description ##### -->
<para>
diff --git a/docs/reference/gtk/tmpl/gtkcellrenderer.sgml b/docs/reference/gtk/tmpl/gtkcellrenderer.sgml
index 90a32b48a..a44b350bd 100644
--- a/docs/reference/gtk/tmpl/gtkcellrenderer.sgml
+++ b/docs/reference/gtk/tmpl/gtkcellrenderer.sgml
@@ -2,7 +2,7 @@
GtkCellRenderer
<!-- ##### SECTION Short_Description ##### -->
-An object for rendering a single cell on a #GdkDrawable
+An object for rendering a single cell on a GdkDrawable
<!-- ##### SECTION Long_Description ##### -->
<para>
diff --git a/docs/reference/gtk/tmpl/gtkgamma.sgml b/docs/reference/gtk/tmpl/gtkgamma.sgml
index 6d061fcff..35719a719 100644
--- a/docs/reference/gtk/tmpl/gtkgamma.sgml
+++ b/docs/reference/gtk/tmpl/gtkgamma.sgml
@@ -2,7 +2,7 @@
GtkGammaCurve
<!-- ##### SECTION Short_Description ##### -->
-a subclass of #GtkCurve for editing gamma curves.
+A subclass of GtkCurve for editing gamma curves
<!-- ##### SECTION Long_Description ##### -->
<note>
diff --git a/docs/reference/gtk/tmpl/gtkhruler.sgml b/docs/reference/gtk/tmpl/gtkhruler.sgml
index 16de20049..ea2cd508f 100644
--- a/docs/reference/gtk/tmpl/gtkhruler.sgml
+++ b/docs/reference/gtk/tmpl/gtkhruler.sgml
@@ -2,7 +2,7 @@
GtkHRuler
<!-- ##### SECTION Short_Description ##### -->
-A horizontal ruler.
+A horizontal ruler
<!-- ##### SECTION Long_Description ##### -->
<note>
diff --git a/docs/reference/gtk/tmpl/gtkliststore.sgml b/docs/reference/gtk/tmpl/gtkliststore.sgml
index 8a66f4399..b5b8a716d 100644
--- a/docs/reference/gtk/tmpl/gtkliststore.sgml
+++ b/docs/reference/gtk/tmpl/gtkliststore.sgml
@@ -2,7 +2,7 @@
GtkListStore
<!-- ##### SECTION Short_Description ##### -->
-A list-like data structure that can be used with the #GtkTreeView
+A list-like data structure that can be used with the GtkTreeView
<!-- ##### SECTION Long_Description ##### -->
<para>
@@ -181,6 +181,18 @@ will cause the #GtkTreeModelFilterVisibleFunc to be visited with an empty row fi
@value:
+<!-- ##### FUNCTION gtk_list_store_set_valuesv ##### -->
+<para>
+
+</para>
+
+@list_store:
+@iter:
+@columns:
+@values:
+@n_values:
+
+
<!-- ##### FUNCTION gtk_list_store_remove ##### -->
<para>
diff --git a/docs/reference/gtk/tmpl/gtkmenubar.sgml b/docs/reference/gtk/tmpl/gtkmenubar.sgml
index 7396daaf5..cce367316 100644
--- a/docs/reference/gtk/tmpl/gtkmenubar.sgml
+++ b/docs/reference/gtk/tmpl/gtkmenubar.sgml
@@ -2,7 +2,7 @@
GtkMenuBar
<!-- ##### SECTION Short_Description ##### -->
-A subclass widget for #GtkMenuShell which holds #GtkMenuItem widgets
+A subclass widget for GtkMenuShell which holds GtkMenuItem widgets
<!-- ##### SECTION Long_Description ##### -->
<para>
diff --git a/docs/reference/gtk/tmpl/gtkrecentchooser.sgml b/docs/reference/gtk/tmpl/gtkrecentchooser.sgml
index 1fa7b35a4..85013ba6f 100644
--- a/docs/reference/gtk/tmpl/gtkrecentchooser.sgml
+++ b/docs/reference/gtk/tmpl/gtkrecentchooser.sgml
@@ -2,7 +2,7 @@
GtkRecentChooser
<!-- ##### SECTION Short_Description ##### -->
-Interface implemented by GtkRecentChooserWidget, GtkRecentChooserMenu and GtkRecentChooserDialog
+Interface implemented by widgets displaying recently used files
<!-- ##### SECTION Long_Description ##### -->
<para>
@@ -45,6 +45,56 @@ Recently used files are supported since GTK+ 2.10.
@recentchooser: the object which received the signal.
+<!-- ##### ARG GtkRecentChooser:filter ##### -->
+<para>
+
+</para>
+
+<!-- ##### ARG GtkRecentChooser:limit ##### -->
+<para>
+
+</para>
+
+<!-- ##### ARG GtkRecentChooser:local-only ##### -->
+<para>
+
+</para>
+
+<!-- ##### ARG GtkRecentChooser:recent-manager ##### -->
+<para>
+
+</para>
+
+<!-- ##### ARG GtkRecentChooser:select-multiple ##### -->
+<para>
+
+</para>
+
+<!-- ##### ARG GtkRecentChooser:show-icons ##### -->
+<para>
+
+</para>
+
+<!-- ##### ARG GtkRecentChooser:show-not-found ##### -->
+<para>
+
+</para>
+
+<!-- ##### ARG GtkRecentChooser:show-private ##### -->
+<para>
+
+</para>
+
+<!-- ##### ARG GtkRecentChooser:show-tips ##### -->
+<para>
+
+</para>
+
+<!-- ##### ARG GtkRecentChooser:sort-type ##### -->
+<para>
+
+</para>
+
<!-- ##### STRUCT GtkRecentChooserIface ##### -->
<para>
diff --git a/docs/reference/gtk/tmpl/gtkscalebutton.sgml b/docs/reference/gtk/tmpl/gtkscalebutton.sgml
index e44e63aa7..df23b8d32 100644
--- a/docs/reference/gtk/tmpl/gtkscalebutton.sgml
+++ b/docs/reference/gtk/tmpl/gtkscalebutton.sgml
@@ -2,7 +2,7 @@
GtkScaleButton
<!-- ##### SECTION Short_Description ##### -->
-
+A button which pops up a scale
<!-- ##### SECTION Long_Description ##### -->
<para>
@@ -50,6 +50,11 @@ GtkScaleButton
</para>
+<!-- ##### ARG GtkScaleButton:icons ##### -->
+<para>
+
+</para>
+
<!-- ##### ARG GtkScaleButton:size ##### -->
<para>
diff --git a/docs/reference/gtk/tmpl/gtkseparator.sgml b/docs/reference/gtk/tmpl/gtkseparator.sgml
index e4d4935b5..2bff699cd 100644
--- a/docs/reference/gtk/tmpl/gtkseparator.sgml
+++ b/docs/reference/gtk/tmpl/gtkseparator.sgml
@@ -2,7 +2,7 @@
GtkSeparator
<!-- ##### SECTION Short_Description ##### -->
-Base class for #GtkHSeparator and #GtkVSeparator
+Base class for GtkHSeparator and GtkVSeparator
<!-- ##### SECTION Long_Description ##### -->
<para>
diff --git a/docs/reference/gtk/tmpl/gtktextbuffer.sgml b/docs/reference/gtk/tmpl/gtktextbuffer.sgml
index 56e783c5e..9b52e8a79 100644
--- a/docs/reference/gtk/tmpl/gtktextbuffer.sgml
+++ b/docs/reference/gtk/tmpl/gtktextbuffer.sgml
@@ -2,9 +2,7 @@
GtkTextBuffer
<!-- ##### SECTION Short_Description ##### -->
-
-Stores attributed text for display in a <link
-linkend="GtkTextView">GtkTextView</link>
+Stores attributed text for display in a GtkTextView
<!-- ##### SECTION Long_Description ##### -->
diff --git a/docs/reference/gtk/tmpl/gtktexttag.sgml b/docs/reference/gtk/tmpl/gtktexttag.sgml
index cf134d502..ff6673085 100644
--- a/docs/reference/gtk/tmpl/gtktexttag.sgml
+++ b/docs/reference/gtk/tmpl/gtktexttag.sgml
@@ -2,8 +2,7 @@
GtkTextTag
<!-- ##### SECTION Short_Description ##### -->
-
-A tag that can be applied to text in a <link linkend="GtkTextBuffer">GtkTextBuffer</link>
+A tag that can be applied to text in a GtkTextBuffer
<!-- ##### SECTION Long_Description ##### -->
<para>
diff --git a/docs/reference/gtk/tmpl/gtktextview.sgml b/docs/reference/gtk/tmpl/gtktextview.sgml
index bbc058401..5479e15f3 100644
--- a/docs/reference/gtk/tmpl/gtktextview.sgml
+++ b/docs/reference/gtk/tmpl/gtktextview.sgml
@@ -2,7 +2,7 @@
GtkTextView
<!-- ##### SECTION Short_Description ##### -->
-Widget that displays a <link linkend="GtkTextBuffer">GtkTextBuffer</link>
+Widget that displays a GtkTextBuffer
<!-- ##### SECTION Long_Description ##### -->
<para>
diff --git a/docs/reference/gtk/tmpl/gtktreemodel.sgml b/docs/reference/gtk/tmpl/gtktreemodel.sgml
index 1bc63fb94..3bd3dfcc2 100644
--- a/docs/reference/gtk/tmpl/gtktreemodel.sgml
+++ b/docs/reference/gtk/tmpl/gtktreemodel.sgml
@@ -2,7 +2,7 @@
GtkTreeModel
<!-- ##### SECTION Short_Description ##### -->
-The tree interface used by #GtkTreeView
+The tree interface used by GtkTreeView
<!-- ##### SECTION Long_Description ##### -->
<para>
diff --git a/docs/reference/gtk/tmpl/gtktreeselection.sgml b/docs/reference/gtk/tmpl/gtktreeselection.sgml
index d3bb88814..1bb4275b6 100644
--- a/docs/reference/gtk/tmpl/gtktreeselection.sgml
+++ b/docs/reference/gtk/tmpl/gtktreeselection.sgml
@@ -2,7 +2,7 @@
GtkTreeSelection
<!-- ##### SECTION Short_Description ##### -->
-The selection object for #GtkTreeView
+The selection object for GtkTreeView
<!-- ##### SECTION Long_Description ##### -->
<para>
diff --git a/docs/reference/gtk/tmpl/gtktreestore.sgml b/docs/reference/gtk/tmpl/gtktreestore.sgml
index 1127c47e1..95b450f22 100644
--- a/docs/reference/gtk/tmpl/gtktreestore.sgml
+++ b/docs/reference/gtk/tmpl/gtktreestore.sgml
@@ -2,7 +2,7 @@
GtkTreeStore
<!-- ##### SECTION Short_Description ##### -->
-A tree-like data structure that can be used with the #GtkTreeView
+A tree-like data structure that can be used with the GtkTreeView
<!-- ##### SECTION Long_Description ##### -->
<para>
@@ -90,6 +90,18 @@ drop</link> interfaces.
@var_args:
+<!-- ##### FUNCTION gtk_tree_store_set_valuesv ##### -->
+<para>
+
+</para>
+
+@tree_store:
+@iter:
+@columns:
+@values:
+@n_values:
+
+
<!-- ##### FUNCTION gtk_tree_store_remove ##### -->
<para>
diff --git a/docs/reference/gtk/tmpl/gtktreeviewcolumn.sgml b/docs/reference/gtk/tmpl/gtktreeviewcolumn.sgml
index e7ccb7ec6..741270710 100644
--- a/docs/reference/gtk/tmpl/gtktreeviewcolumn.sgml
+++ b/docs/reference/gtk/tmpl/gtktreeviewcolumn.sgml
@@ -2,7 +2,7 @@
GtkTreeViewColumn
<!-- ##### SECTION Short_Description ##### -->
-A visible column in a #GtkTreeView widget
+A visible column in a GtkTreeView widget
<!-- ##### SECTION Long_Description ##### -->
<para>
@@ -613,3 +613,12 @@ calling gtk_tree_view_column_set_cell_data_func()
@tree_column:
+<!-- ##### FUNCTION gtk_tree_view_column_get_tree_view ##### -->
+<para>
+
+</para>
+
+@tree_column:
+@Returns:
+
+
diff --git a/docs/reference/gtk/tmpl/gtkvolumebutton.sgml b/docs/reference/gtk/tmpl/gtkvolumebutton.sgml
index cf7e49e91..a4c3fb643 100644
--- a/docs/reference/gtk/tmpl/gtkvolumebutton.sgml
+++ b/docs/reference/gtk/tmpl/gtkvolumebutton.sgml
@@ -2,7 +2,7 @@
GtkVolumeButton
<!-- ##### SECTION Short_Description ##### -->
-
+A button which pops up a volume control
<!-- ##### SECTION Long_Description ##### -->
<para>
diff --git a/docs/reference/gtk/tmpl/gtkvruler.sgml b/docs/reference/gtk/tmpl/gtkvruler.sgml
index 77f151360..89b8af90f 100644
--- a/docs/reference/gtk/tmpl/gtkvruler.sgml
+++ b/docs/reference/gtk/tmpl/gtkvruler.sgml
@@ -2,7 +2,7 @@
GtkVRuler
<!-- ##### SECTION Short_Description ##### -->
-A vertical ruler.
+A vertical ruler
<!-- ##### SECTION Long_Description ##### -->
<note>
diff --git a/docs/reference/gtk/tree_widget.sgml b/docs/reference/gtk/tree_widget.sgml
index 4dee9c089..8e4292976 100644
--- a/docs/reference/gtk/tree_widget.sgml
+++ b/docs/reference/gtk/tree_widget.sgml
@@ -7,8 +7,7 @@
<refnamediv>
<refname>Tree and List Widget Overview</refname>
- <refpurpose>Overview of #GtkTreeModel, #GtkTreeView, and other
- associated widgets</refpurpose>
+ <refpurpose>Overview of GtkTreeModel, GtkTreeView, and friends</refpurpose>
</refnamediv>
<refsect1>