Doc formatting tweaks.

2003-10-01  Matthias Clasen  <maclas@gmx.de>

	* gtk/gtkmain.c: Doc formatting tweaks.

	* gtk/gtktoolitem.c (gtk_tool_item_set_is_important): Fix a typo.

	* gtk/gtkcheckmenuitem.h (gtk_check_menu_item_set_draw_as_radio):
	Use the same parameter names as in .c file, to pacify gtk-doc.

	* gtk/gtktoggletoolbutton.[hc]:
	* gtk/gtktoolbutton.[hc]:
	* gtk/gtktoolitem.[hc]:
	* gtk/gtktoolbar.[hc]:
	* gtk/gtkcolorbutton.[hc]:
	* gtk/gtkfontbutton.[hc]:
	* gtk/gtkalignment.[hc]: Define GET_PRIVATE macros in the
	source, not in the header.

	* gtk/gtkcheckmenuitem.c (gtk_check_menu_item_[sg]et_draw_as_radio):
	Document these as 2.4 API additions.

	* gtk/tmpl/gtkaction.sgml: Fix cross reference to GtkMenuMerge.

	* gtk/gtk-sections.txt: Additions.

	* gtk/tmpl/gtkitemfactory.sgml: Add hint to use #GtkUIManager instead.

16 files changed, 41 insertions, 35 deletions

diff --git a/gtk/gtkalignment.c b/gtk/gtkalignment.c
index 01ba014188..2751895954 100644
--- a/gtk/gtkalignment.c
+++ b/gtk/gtkalignment.c
@@ -43,6 +43,8 @@ enum {
   PROP_LAST
 };
 
+#define GTK_ALIGNMENT_GET_PRIVATE(o)  (G_TYPE_INSTANCE_GET_PRIVATE ((o), GTK_TYPE_ALIGNMENT, GtkAlignmentPrivate))
+
 struct _GtkAlignmentPrivate
 {
   guint padding_top;
diff --git a/gtk/gtkcheckmenuitem.c b/gtk/gtkcheckmenuitem.c
index 75db42a7f5..fda7288122 100644
--- a/gtk/gtkcheckmenuitem.c
+++ b/gtk/gtkcheckmenuitem.c
@@ -322,6 +322,7 @@ gtk_check_menu_item_get_inconsistent (GtkCheckMenuItem *check_menu_item)
  *
  * Sets whether @check_menu_item is drawn like a #GtkRadioMenuItem
  *
+ * Since: 2.4
  **/
 void
 gtk_check_menu_item_set_draw_as_radio (GtkCheckMenuItem *check_menu_item,
@@ -348,6 +349,8 @@ gtk_check_menu_item_set_draw_as_radio (GtkCheckMenuItem *check_menu_item,
  * Returns whether @check_menu_item looks like a #GtkRadioMenuItem
  * 
  * Return value: Whether @check_menu_item looks like a #GtkRadioMenuItem
+ * 
+ * Since: 2.4
  **/
 gboolean
 gtk_check_menu_item_get_draw_as_radio (GtkCheckMenuItem *check_menu_item)
diff --git a/gtk/gtkcheckmenuitem.h b/gtk/gtkcheckmenuitem.h
index 3572b7708a..74b1ef133e 100644
--- a/gtk/gtkcheckmenuitem.h
+++ b/gtk/gtkcheckmenuitem.h
@@ -87,7 +87,7 @@ void       gtk_check_menu_item_set_inconsistent  (GtkCheckMenuItem *check_menu_i
 						  gboolean          setting);
 gboolean   gtk_check_menu_item_get_inconsistent  (GtkCheckMenuItem *check_menu_item);
 void       gtk_check_menu_item_set_draw_as_radio (GtkCheckMenuItem *check_menu_item,
-						  gboolean          draw_radio_indicator);
+						  gboolean          draw_as_radio);
 gboolean   gtk_check_menu_item_get_draw_as_radio (GtkCheckMenuItem *check_menu_item);
     
 
diff --git a/gtk/gtkcolorbutton.c b/gtk/gtkcolorbutton.c
index b6896279d7..c9cd5cdb7f 100644
--- a/gtk/gtkcolorbutton.c
+++ b/gtk/gtkcolorbutton.c
@@ -50,6 +50,8 @@
 #define CHECK_DARK  21845  /* 65535 / 3     */
 #define CHECK_LIGHT 43690 
 
+#define GTK_COLOR_BUTTON_GET_PRIVATE(obj) (G_TYPE_INSTANCE_GET_PRIVATE ((obj), GTK_TYPE_COLOR_BUTTON, GtkColorButtonPrivate))
+
 struct _GtkColorButtonPrivate 
 {
   GdkPixbuf *pixbuf;    /* Pixbuf for rendering sample */
diff --git a/gtk/gtkcolorbutton.h b/gtk/gtkcolorbutton.h
index ed67ccfdaa..be8ec8fe7d 100644
--- a/gtk/gtkcolorbutton.h
+++ b/gtk/gtkcolorbutton.h
@@ -49,7 +49,6 @@ G_BEGIN_DECLS
 #define GTK_IS_COLOR_BUTTON(obj)          (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GTK_TYPE_COLOR_BUTTON))
 #define GTK_IS_COLOR_BUTTON_CLASS(klass)  (G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_TYPE_COLOR_BUTTON))
 #define GTK_COLOR_BUTTON_GET_CLASS(obj)   (G_TYPE_INSTANCE_GET_CLASS ((obj), GTK_TYPE_COLOR_BUTTON, GtkColorButtonClass))
-#define GTK_COLOR_BUTTON_GET_PRIVATE(obj) (G_TYPE_INSTANCE_GET_PRIVATE ((obj), GTK_TYPE_COLOR_BUTTON, GtkColorButtonPrivate))
 
 typedef struct _GtkColorButton          GtkColorButton;
 typedef struct _GtkColorButtonClass     GtkColorButtonClass;
diff --git a/gtk/gtkfontbutton.c b/gtk/gtkfontbutton.c
index 05bfc3f42a..fea8f2087e 100644
--- a/gtk/gtkfontbutton.c
+++ b/gtk/gtkfontbutton.c
@@ -44,6 +44,8 @@
 #include <string.h>
 #include <stdio.h>
 
+#define GTK_FONT_BUTTON_GET_PRIVATE(obj) (G_TYPE_INSTANCE_GET_PRIVATE ((obj), GTK_TYPE_FONT_BUTTON, GtkFontButtonPrivate))
+
 struct _GtkFontButtonPrivate 
 {
   gchar         *title;
diff --git a/gtk/gtkfontbutton.h b/gtk/gtkfontbutton.h
index 896ef335d4..8952569b90 100644
--- a/gtk/gtkfontbutton.h
+++ b/gtk/gtkfontbutton.h
@@ -41,7 +41,6 @@ G_BEGIN_DECLS
 #define GTK_IS_FONT_BUTTON(obj)          (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GTK_TYPE_FONT_BUTTON))
 #define GTK_IS_FONT_BUTTON_CLASS(klass)  (G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_TYPE_FONT_BUTTON))
 #define GTK_FONT_BUTTON_GET_CLASS(obj)   (G_TYPE_INSTANCE_GET_CLASS ((obj), GTK_TYPE_FONT_BUTTON, GtkFontButtonClass))
-#define GTK_FONT_BUTTON_GET_PRIVATE(obj) (G_TYPE_INSTANCE_GET_PRIVATE ((obj), GTK_TYPE_FONT_BUTTON, GtkFontButtonPrivate))
 
 typedef struct _GtkFontButton        GtkFontButton;
 typedef struct _GtkFontButtonClass   GtkFontButtonClass;
diff --git a/gtk/gtkmain.c b/gtk/gtkmain.c
index 78dc4d1c02..ea9297be32 100644
--- a/gtk/gtkmain.c
+++ b/gtk/gtkmain.c
@@ -413,8 +413,8 @@ module_build_la_path (const gchar *directory,
  * @name: the name of the module
  * @type: the type of the module, for instance 'modules', 'engines', immodules'
  * 
- * Looks for a dynamically module named @name of type @type in the standard GTK+
- *  module search path.
+ * Looks for a dynamically loadable module named @name of type @type in the
+ * standard GTK+ module search path.
  * 
  * Return value: the pathname to the found module, or %NULL if it wasn't found.
  *  Free with g_free().
@@ -611,8 +611,8 @@ display_opened_cb (GdkDisplayManager *display_manager,
 
 /**
  * gdk_parse_args:
- * @argc: the number of command line arguments.
- * @argv: the array of command line arguments.
+ * @argc: a pointer to the number of command line arguments.
+ * @argv: a pointer to the array of command line arguments.
  * 
  * Parses command line arguments, and initializes global
  * attributes of GTK+, but does not actually open a connection
@@ -847,11 +847,9 @@ gtk_parse_args (int    *argc,
 /**
  * gtk_init_check:
  * @argc: Address of the <parameter>argc</parameter> parameter of your 
- *   <function>main()</function> function. Changed if any arguments were 
- *   handled.
- * @argv: Address of the <parameter>argv</parameter> parameter of 
- *   <function>main()</function>. Any parameters understood by gtk_init() 
- *   are stripped before return.
+ *   main() function. Changed if any arguments were handled.
+ * @argv: Address of the <parameter>argv</parameter> parameter of main(). 
+ *   Any parameters understood by gtk_init() are stripped before return.
  * 
  * This function does the same work as gtk_init() with only 
  * a single change: It does not terminate the program if the GUI can't be 
@@ -878,15 +876,13 @@ gtk_init_check (int	 *argc,
 /**
  * gtk_init:
  * @argc: Address of the <parameter>argc</parameter> parameter of your 
- *   <function>main()</function> function. Changed if any arguments were 
- *   handled.
- * @argv: Address of the <parameter>argv</parameter> parameter of 
- *   <function>main()</function>. Any parameters understood by gtk_init() 
- *   are stripped before return.
+ *   main() function. Changed if any arguments were handled.
+ * @argv: Address of the <parameter>argv</parameter> parameter of main(). 
+ *   Any parameters understood by gtk_init() are stripped before return.
  * 
  * Call this function before using any other GTK+ functions in your GUI
- * applications.  It will initialize everything needed to operate the toolkit and
- * parses some standard command line options. @argc and 
+ * applications.  It will initialize everything needed to operate the 
+ * toolkit and parses some standard command line options. @argc and 
  * @argv are adjusted accordingly so your own code will 
  * never see those standard arguments.
  *
@@ -989,13 +985,12 @@ gtk_exit (gint errorcode)
  * <literal>setlocale (LC_ALL, "")</literal> but also takes care of the 
  * locale specific setup of the windowing system used by GDK.
  * 
- * Return: a string corresponding to the locale set, typically in the
+ * Returns: a string corresponding to the locale set, typically in the
  * form lang_COUNTRY, where lang is an ISO-639 language code, and
  * COUNTRY is an ISO-3166 country code. On Unix, this form matches the
- * result of the <function>setlocale()</function>; it is also used on
- * other machines, such as Windows, where the C library returns a
- * different result. The string is owned by GTK+ and should not be
- * modified or freed.
+ * result of the setlocale(); it is also used on other machines, such as 
+ * Windows, where the C library returns a different result. The string is 
+ * owned by GTK+ and should not be modified or freed.
  **/
 gchar *
 gtk_set_locale (void)
@@ -1018,11 +1013,11 @@ gtk_set_locale (void)
  * 
  * On Windows, the C library doesn't use any such environment
  * variables, and setting them won't affect the behaviour of functions
- * like <function>ctime()</function>. The user sets the locale through
- * the Regional Options in the Control Panel. The C library (in the
- * <function>setlocale()</function> function) does not use country and
- * language codes, but country and language names spelled out in
- * English. However, this function does check the above environment
+ * like ctime(). The user sets the locale through the Regional Options 
+ * in the Control Panel. The C library (in the setlocale() function) 
+ * does not use country and language codes, but country and language 
+ * names spelled out in English. 
+ * However, this function does check the above environment
  * variables, and does return a Unix-style locale string based on
  * either said environment variables or the thread's current locale.
  *
@@ -1071,7 +1066,7 @@ _gtk_get_lc_ctype (void)
  * application.)  The default language is derived from the current
  * locale. It determines, for example, whether GTK+ uses the
  * right-to-left or left-to-right text direction. See
- * _gtk_get_lc_ctype for notes on behaviour on Windows.
+ * _gtk_get_lc_ctype() for notes on behaviour on Windows.
  * 
  * Return value: the default language as a #PangoLanguage, must not be
  * freed
diff --git a/gtk/gtktoggletoolbutton.c b/gtk/gtktoggletoolbutton.c
index 02c076feed..a994b2b901 100644
--- a/gtk/gtktoggletoolbutton.c
+++ b/gtk/gtktoggletoolbutton.c
@@ -34,6 +34,8 @@ enum {
   LAST_SIGNAL
 };
 
+#define GTK_TOGGLE_TOOL_BUTTON_GET_PRIVATE(obj) (G_TYPE_INSTANCE_GET_PRIVATE ((obj), GTK_TYPE_TOGGLE_TOOL_BUTTON, GtkToggleToolButtonPrivate))
+
 struct _GtkToggleToolButtonPrivate
 {
   guint active : 1;
diff --git a/gtk/gtktoggletoolbutton.h b/gtk/gtktoggletoolbutton.h
index 341cdcbeb5..0d5b1ad19d 100644
--- a/gtk/gtktoggletoolbutton.h
+++ b/gtk/gtktoggletoolbutton.h
@@ -33,7 +33,6 @@ G_BEGIN_DECLS
 #define GTK_IS_TOGGLE_TOOL_BUTTON(obj)          (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GTK_TYPE_TOGGLE_TOOL_BUTTON))
 #define GTK_IS_TOGGLE_TOOL_BUTTON_CLASS(klass)  (G_TYPE_CHECK_CLASS_TYPE ((obj), GTK_TYPE_TOGGLE_TOOL_BUTTON))
 #define GTK_TOGGLE_TOOL_BUTTON_GET_CLASS(obj)   (G_TYPE_INSTANCE_GET_CLASS((obj), GTK_TYPE_TOGGLE_TOOL_BUTTON, GtkToggleToolButtonClass))
-#define GTK_TOGGLE_TOOL_BUTTON_GET_PRIVATE(obj) (G_TYPE_INSTANCE_GET_PRIVATE ((obj), GTK_TYPE_TOGGLE_TOOL_BUTTON, GtkToggleToolButtonPrivate))
 
 typedef struct _GtkToggleToolButton        GtkToggleToolButton;
 typedef struct _GtkToggleToolButtonClass   GtkToggleToolButtonClass;
diff --git a/gtk/gtktoolbar.c b/gtk/gtktoolbar.c
index bb802079c3..dd5e8328d5 100644
--- a/gtk/gtktoolbar.c
+++ b/gtk/gtktoolbar.c
@@ -191,6 +191,8 @@ typedef enum {
   NEW_API
 } ApiMode;
 
+#define GTK_TOOLBAR_GET_PRIVATE(o)  (G_TYPE_INSTANCE_GET_PRIVATE ((o), GTK_TYPE_TOOLBAR, GtkToolbarPrivate))
+
 struct _GtkToolbarPrivate
 {
   GList     *items;
diff --git a/gtk/gtktoolbar.h b/gtk/gtktoolbar.h
index fce9b7b2a0..f4e64d31de 100644
--- a/gtk/gtktoolbar.h
+++ b/gtk/gtktoolbar.h
@@ -55,7 +55,6 @@ G_BEGIN_DECLS
 #define GTK_IS_TOOLBAR(obj)         (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GTK_TYPE_TOOLBAR))
 #define GTK_IS_TOOLBAR_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_TYPE_TOOLBAR))
 #define GTK_TOOLBAR_GET_CLASS(obj)  (G_TYPE_INSTANCE_GET_CLASS ((obj), GTK_TYPE_TOOLBAR, GtkToolbarClass))
-#define GTK_TOOLBAR_GET_PRIVATE(o)  (G_TYPE_INSTANCE_GET_PRIVATE ((o), GTK_TYPE_TOOLBAR, GtkToolbarPrivate))
 
 #ifndef GTK_DISABLE_DEPRECATED
 typedef enum
diff --git a/gtk/gtktoolbutton.c b/gtk/gtktoolbutton.c
index 5382b7d11d..8fe2b6b74c 100644
--- a/gtk/gtktoolbutton.c
+++ b/gtk/gtktoolbutton.c
@@ -76,6 +76,8 @@ static void gtk_tool_button_construct_contents (GtkToolItem *tool_item);
 static GObjectClass *parent_class = NULL;
 static guint         toolbutton_signals[LAST_SIGNAL] = { 0 };
 
+#define GTK_TOOL_BUTTON_GET_PRIVATE(obj)(G_TYPE_INSTANCE_GET_PRIVATE ((obj), GTK_TYPE_TOOL_BUTTON, GtkToolButtonPrivate))
+
 struct _GtkToolButtonPrivate
 {
   GtkWidget *button;
diff --git a/gtk/gtktoolbutton.h b/gtk/gtktoolbutton.h
index 591857aa43..236905bb41 100644
--- a/gtk/gtktoolbutton.h
+++ b/gtk/gtktoolbutton.h
@@ -33,7 +33,6 @@ G_BEGIN_DECLS
 #define GTK_IS_TOOL_BUTTON(obj)         (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GTK_TYPE_TOOL_BUTTON))
 #define GTK_IS_TOOL_BUTTON_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((obj), GTK_TYPE_TOOL_BUTTON))
 #define GTK_TOOL_BUTTON_GET_CLASS(obj)  (G_TYPE_INSTANCE_GET_CLASS((obj), GTK_TYPE_TOOL_BUTTON, GtkToolButtonClass))
-#define GTK_TOOL_BUTTON_GET_PRIVATE(obj)(G_TYPE_INSTANCE_GET_PRIVATE ((obj), GTK_TYPE_TOOL_BUTTON, GtkToolButtonPrivate))
 
 typedef struct _GtkToolButton        GtkToolButton;
 typedef struct _GtkToolButtonClass   GtkToolButtonClass;
diff --git a/gtk/gtktoolitem.c b/gtk/gtktoolitem.c
index a75cd6232a..3f6652001f 100644
--- a/gtk/gtktoolitem.c
+++ b/gtk/gtktoolitem.c
@@ -43,6 +43,8 @@ enum {
   PROP_IS_IMPORTANT
 };
 
+#define GTK_TOOL_ITEM_GET_PRIVATE(o)  (G_TYPE_INSTANCE_GET_PRIVATE ((o), GTK_TYPE_TOOL_ITEM, GtkToolItemPrivate))
+
 struct _GtkToolItemPrivate
 {
   gchar *tip_text;
@@ -779,7 +781,7 @@ gtk_tool_item_get_is_important (GtkToolItem *tool_item)
 /**
  * gtk_tool_item_set_is_important:
  * @tool_item: a #GtkToolItem
- * @is_imporatnt: whether the tool item should be considered important
+ * @is_important: whether the tool item should be considered important
  * 
  * Sets whether @tool_item should be considered important. The #GtkToolButton
  * class uses this property to determine whether to show or hide its label
diff --git a/gtk/gtktoolitem.h b/gtk/gtktoolitem.h
index ea5d4c642a..9d9b34ecc2 100644
--- a/gtk/gtktoolitem.h
+++ b/gtk/gtktoolitem.h
@@ -33,7 +33,6 @@
 #define GTK_IS_TOOL_ITEM(o)           (G_TYPE_CHECK_INSTANCE_TYPE ((o), GTK_TYPE_TOOL_ITEM))
 #define GTK_IS_TOOL_ITEM_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((o), GTK_TYPE_TOOL_ITEM))
 #define GTK_TOOL_ITEM_GET_CLASS(o)    (G_TYPE_INSTANCE_GET_CLASS((o), GTK_TYPE_TOOL_ITEM, GtkToolItemClass))
-#define GTK_TOOL_ITEM_GET_PRIVATE(o)  (G_TYPE_INSTANCE_GET_PRIVATE ((o), GTK_TYPE_TOOL_ITEM, GtkToolItemPrivate))
 
 typedef struct _GtkToolItem        GtkToolItem;
 typedef struct _GtkToolItemClass   GtkToolItemClass;