Docs for GtkAboutDialog.

diff --git a/docs/reference/ChangeLog b/docs/reference/ChangeLog
index 8f6dbf8d1fb55f22a19d16f952387e802e16bf32..352d234a1d7094d49cae7dc88dac2e6a9e9a8693 100644 (file)
--- a/docs/reference/ChangeLog
+++ b/docs/reference/ChangeLog
@@ -1,3 +1,11 @@
+2004-07-12  Matthias Clasen  <mclasen@redhat.com>
+
+       * gtk/gtk-docs.sgml: Add GtkAboutDialog to "Display 
+       Widgets" for now.
+
+       * gtk/gtk-sections.txt: Add GtkAboutDialog section.
+       * gtk/tmpl/gtkaboutdialog.sgml: New file.
+
 Mon Jul 12 00:57:32 2004  Matthias Clasen  <maclas@gmx.de>
 
        * gtk/tmpl/gtkstock.sgml: 

diff --git a/docs/reference/gtk/gtk-docs.sgml b/docs/reference/gtk/gtk-docs.sgml
index eeb4a30a420a49859f038c9d9de8f0d0a7d9fcfe..8e6eaf57a535271448a462575585c1ae4bd8ebfd 100644 (file)
--- a/docs/reference/gtk/gtk-docs.sgml
+++ b/docs/reference/gtk/gtk-docs.sgml
@@ -1,6 +1,7 @@
 <?xml version="1.0"?>
 <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" 
                "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
+<!ENTITY GtkAboutDialog SYSTEM "xml/gtkaboutdialog.xml">
 <!ENTITY GtkAccelLabel SYSTEM "xml/gtkaccellabel.xml">
 <!ENTITY GtkAction SYSTEM "xml/gtkaction.xml">
 <!ENTITY GtkActionGroup SYSTEM "xml/gtkactiongroup.xml">
@@ -332,6 +333,7 @@ that is, GUI components such as <link linkend="GtkButton">GtkButton</link> or
 
     <chapter id="DisplayWidgets">
       <title>Display Widgets</title>
+        &GtkAboutDialog;
         &GtkAccelLabel;
         &GtkImage;
         &GtkLabel;

diff --git a/docs/reference/gtk/gtk-sections.txt b/docs/reference/gtk/gtk-sections.txt
index f4cdc976e8c25dbd777d5bc23934645adc24915f..76618e0a307b0765830e8f11bffe8249f3bcfe15 100644 (file)
--- a/docs/reference/gtk/gtk-sections.txt
+++ b/docs/reference/gtk/gtk-sections.txt
@@ -1,6 +1,48 @@
 
 <INCLUDE>gtk/gtk.h</INCLUDE>
 
+<SECTION>
+<FILE>gtkaboutdialog</FILE>
+<TITLE>GtkAboutDialog</TITLE>
+GtkAboutDialog
+gtk_about_dialog_new
+gtk_about_dialog_get_name
+gtk_about_dialog_set_name
+gtk_about_dialog_get_version
+gtk_about_dialog_set_version
+gtk_about_dialog_get_copyright
+gtk_about_dialog_set_copyright
+gtk_about_dialog_get_comments
+gtk_about_dialog_set_comments
+gtk_about_dialog_get_license
+gtk_about_dialog_set_license
+gtk_about_dialog_get_website
+gtk_about_dialog_set_website
+gtk_about_dialog_get_website_label
+gtk_about_dialog_set_website_label
+gtk_about_dialog_get_authors
+gtk_about_dialog_set_authors
+gtk_about_dialog_get_documenters
+gtk_about_dialog_set_documenters
+gtk_about_dialog_get_translator_credits
+gtk_about_dialog_set_translator_credits
+gtk_about_dialog_get_logo
+gtk_about_dialog_set_logo
+GtkAboutDialogActivateLinkFunc
+gtk_about_dialog_set_email_hook
+gtk_about_dialog_set_url_hook
+gtk_show_about_dialog
+<SUBSECTION Standard>
+GTK_ABOUT_DIALOG
+GTK_IS_ABOUT_DIALOG
+GTK_TYPE_ABOUT_DIALOG
+GTK_ABOUT_DIALOG_CLASS
+GTK_IS_ABOUT_DIALOG_CLASS
+GTK_ABOUT_DIALOG_GET_CLASS
+<SUBSECTION Private>
+gtk_about_dialog_get_type
+</SECTION>
+
 <SECTION>
 <FILE>gtkaccelgroup</FILE>
 <TITLE>Keyboard Accelerators</TITLE>

diff --git a/docs/reference/gtk/tmpl/gtkaboutdialog.sgml b/docs/reference/gtk/tmpl/gtkaboutdialog.sgml
new file mode 100644 (file)
index 0000000..13a6b6b
--- /dev/null
+++ b/docs/reference/gtk/tmpl/gtkaboutdialog.sgml
@@ -0,0 +1,268 @@
+<!-- ##### SECTION Title ##### -->
+GtkAboutDialog
+
+<!-- ##### SECTION Short_Description ##### -->
+
+
+<!-- ##### SECTION Long_Description ##### -->
+<para>
+
+</para>
+
+
+<!-- ##### SECTION See_Also ##### -->
+<para>
+
+</para>
+
+
+<!-- ##### STRUCT GtkAboutDialog ##### -->
+<para>
+
+</para>
+
+@parent_instance: 
+
+<!-- ##### FUNCTION gtk_about_dialog_new ##### -->
+<para>
+
+</para>
+
+@Returns: 
+
+
+<!-- ##### FUNCTION gtk_about_dialog_get_name ##### -->
+<para>
+
+</para>
+
+@about: 
+@Returns: 
+
+
+<!-- ##### FUNCTION gtk_about_dialog_set_name ##### -->
+<para>
+
+</para>
+
+@about: 
+@name: 
+
+
+<!-- ##### FUNCTION gtk_about_dialog_get_version ##### -->
+<para>
+
+</para>
+
+@about: 
+@Returns: 
+
+
+<!-- ##### FUNCTION gtk_about_dialog_set_version ##### -->
+<para>
+
+</para>
+
+@about: 
+@version: 
+
+
+<!-- ##### FUNCTION gtk_about_dialog_get_copyright ##### -->
+<para>
+
+</para>
+
+@about: 
+@Returns: 
+
+
+<!-- ##### FUNCTION gtk_about_dialog_set_copyright ##### -->
+<para>
+
+</para>
+
+@about: 
+@copyright: 
+
+
+<!-- ##### FUNCTION gtk_about_dialog_get_comments ##### -->
+<para>
+
+</para>
+
+@about: 
+@Returns: 
+
+
+<!-- ##### FUNCTION gtk_about_dialog_set_comments ##### -->
+<para>
+
+</para>
+
+@about: 
+@comments: 
+
+
+<!-- ##### FUNCTION gtk_about_dialog_get_license ##### -->
+<para>
+
+</para>
+
+@about: 
+@Returns: 
+
+
+<!-- ##### FUNCTION gtk_about_dialog_set_license ##### -->
+<para>
+
+</para>
+
+@about: 
+@license: 
+
+
+<!-- ##### FUNCTION gtk_about_dialog_get_website ##### -->
+<para>
+
+</para>
+
+@about: 
+@Returns: 
+
+
+<!-- ##### FUNCTION gtk_about_dialog_set_website ##### -->
+<para>
+
+</para>
+
+@about: 
+@website: 
+
+
+<!-- ##### FUNCTION gtk_about_dialog_get_website_label ##### -->
+<para>
+
+</para>
+
+@about: 
+@Returns: 
+
+
+<!-- ##### FUNCTION gtk_about_dialog_set_website_label ##### -->
+<para>
+
+</para>
+
+@about: 
+@website_label: 
+
+
+<!-- ##### FUNCTION gtk_about_dialog_get_authors ##### -->
+<para>
+
+</para>
+
+@about: 
+@Returns: 
+
+
+<!-- ##### FUNCTION gtk_about_dialog_set_authors ##### -->
+<para>
+
+</para>
+
+@about: 
+@authors: 
+
+
+<!-- ##### FUNCTION gtk_about_dialog_get_documenters ##### -->
+<para>
+
+</para>
+
+@about: 
+@Returns: 
+
+
+<!-- ##### FUNCTION gtk_about_dialog_set_documenters ##### -->
+<para>
+
+</para>
+
+@about: 
+@documenters: 
+
+
+<!-- ##### FUNCTION gtk_about_dialog_get_translator_credits ##### -->
+<para>
+
+</para>
+
+@about: 
+@Returns: 
+
+
+<!-- ##### FUNCTION gtk_about_dialog_set_translator_credits ##### -->
+<para>
+
+</para>
+
+@about: 
+@translator_credits: 
+
+
+<!-- ##### FUNCTION gtk_about_dialog_get_logo ##### -->
+<para>
+
+</para>
+
+@about: 
+@Returns: 
+
+
+<!-- ##### FUNCTION gtk_about_dialog_set_logo ##### -->
+<para>
+
+</para>
+
+@about: 
+@logo: 
+
+
+<!-- ##### USER_FUNCTION GtkAboutDialogActivateLinkFunc ##### -->
+<para>
+
+</para>
+
+@about: 
+@link: 
+
+
+<!-- ##### FUNCTION gtk_about_dialog_set_email_hook ##### -->
+<para>
+
+</para>
+
+@func: 
+@Returns: 
+
+
+<!-- ##### FUNCTION gtk_about_dialog_set_url_hook ##### -->
+<para>
+
+</para>
+
+@func: 
+@Returns: 
+
+
+<!-- ##### FUNCTION gtk_show_about_dialog ##### -->
+<para>
+
+</para>
+
+@parent: 
+@first_property_name: 
+@Varargs: 
+
+

diff --git a/gtk/gtkaboutdialog.c b/gtk/gtkaboutdialog.c
index aeb1e115a213178b798f126b8f543e00249a593f..aa4c8b810a020358e8513222fd64a44a53aa5ad0 100644 (file)
--- a/gtk/gtkaboutdialog.c
+++ b/gtk/gtkaboutdialog.c
@@ -1036,7 +1036,7 @@ gtk_about_dialog_get_documenters (GtkAboutDialog *about)
 /**
  * gtk_about_dialog_set_documenters:
  * @about: a #GtkAboutDialog
- * @authors: a %NULL-terminated array of strings 
+ * @documenters: a %NULL-terminated array of strings 
  *
  * Sets the strings which are displayed in the documenters tab
  * of the secondary credits dialog. 
@@ -1092,7 +1092,7 @@ gtk_about_dialog_get_artists (GtkAboutDialog *about)
 /**
  * gtk_about_dialog_set_artists:
  * @about: a #GtkAboutDialog
- * @authors: a %NULL-terminated array of strings 
+ * @artists: a %NULL-terminated array of strings 
  *
  * Sets the strings which are displayed in the artists tab
  * of the secondary credits dialog. 
@@ -1227,7 +1227,7 @@ icon_set_new_from_pixbufs (GList *pixbufs)
 /**
  * gtk_about_dialog_set_logo:
  * @about: a #GtkAboutDialog
- * @pixbuf: a #GdkPixbuf, or %NULL
+ * @logo: a #GdkPixbuf, or %NULL
  * 
  * Sets the pixbuf to be displayed as logo in 
  * the about dialog. If it is %NULL, the default
@@ -1238,7 +1238,7 @@ icon_set_new_from_pixbufs (GList *pixbufs)
  **/
 void
 gtk_about_dialog_set_logo (GtkAboutDialog *about,
-                          GdkPixbuf      *pixbuf)
+                          GdkPixbuf      *logo)
 {
   GtkAboutDialogPrivate *priv;
 
@@ -1246,8 +1246,8 @@ gtk_about_dialog_set_logo (GtkAboutDialog *about,
 
   priv = (GtkAboutDialogPrivate *)about->private_data;
 
-  if (pixbuf != NULL) 
-    gtk_image_set_from_pixbuf (GTK_IMAGE (priv->logo_image), pixbuf);
+  if (logo != NULL) 
+    gtk_image_set_from_pixbuf (GTK_IMAGE (priv->logo_image), logo);
   else 
     {
       GList *pixbufs = gtk_window_get_default_icon_list ();
@@ -1781,7 +1781,7 @@ gtk_about_dialog_set_email_hook (GtkAboutDialogActivateLinkFunc func)
 }
 
 /**
- * gtk_about_dialog_set_email_hook:
+ * gtk_about_dialog_set_url_hook:
  * @func: a function to call when a URL link is activated.
  * 
  * Installs a global function to be called whenever the user activates a