Move docs inline

2007-05-26   Matthias Clasen  <mclasen@redhat.com>

        * gtk/tmpl/gtkentry.sgml: Move docs inline

        * gtk/tmpl/gtklinkbutton.sgml:
        * gtk/tmpl/gtkfilechooser.sgml:
        * gtk/tmpl/gtkcellrenderer.sgml:
        * gtk/tmpl/gtkenums.sgml:
        * gtk/tmpl/gtkcontainer.sgml: Additions



svn path=/trunk/; revision=17947

ChangeLog

@@ -1,3 +1,7 @@
+2007-05-26  Matthias Clasen  <mclasen@redhat.com>
+
+	* gtk/gtkentry.c: Move docs inline.
+
 2007-05-26  Matthias Clasen  <mclasen@redhat.com>
 
 	* gdk/directfb/gdkkeys-directfb.c: Remove duplicate doc comments

docs/reference/ChangeLog

@@ -1,10 +1,20 @@
+2007-05-26   Matthias Clasen  <mclasen@redhat.com>
+
+	* gtk/tmpl/gtkentry.sgml: Move docs inline
+
+	* gtk/tmpl/gtklinkbutton.sgml:
+	* gtk/tmpl/gtkfilechooser.sgml:
+	* gtk/tmpl/gtkcellrenderer.sgml:
+	* gtk/tmpl/gtkenums.sgml:
+	* gtk/tmpl/gtkcontainer.sgml: Additions
+
 2007-05-26   Matthias Clasen  <mclasen@redhat.com>
 
 	* gdk/gdk-overrides.txt: Remove GdkBitmap
 	* gtk/gtk-sections.txt:
-	* gtk/gtkenums.sgml:
+	* gtk/tmpl/gtkenums.sgml:
-	* gdk/rgb.sgml:
+	* gdk/tmpl/rgb.sgml:
-	* gdk/gcs.sgml:
+	* gdk/tmpl/gcs.sgml:
 	* gdk/tmpl/pango_interaction.sgml:
 	* gdk/tmpl/windows.sgml: Additions
 

docs/reference/gtk/tmpl/gtkcellrenderer.sgml

@@ -61,7 +61,7 @@ probably has a selection colored background to render to.
 @GTK_CELL_RENDERER_PRELIT: The mouse is hovering over the cell.
 @GTK_CELL_RENDERER_INSENSITIVE: The cell is drawn in an insensitive manner
 @GTK_CELL_RENDERER_SORTED: The cell is in a sorted row
-@GTK_CELL_RENDERER_FOCUSED: 
+@GTK_CELL_RENDERER_FOCUSED: The cell is in the focus row. 
 
 <!-- ##### ENUM GtkCellRendererMode ##### -->
 <para>

docs/reference/gtk/tmpl/gtkcontainer.sgml

@@ -161,12 +161,14 @@ changes, use gtk_widget_child_notify().
 
 <!-- ##### MACRO GTK_CONTAINER_WARN_INVALID_CHILD_PROPERTY_ID ##### -->
 <para>
-
+This macro should be used to emit a standard warning about unexpected
+properties in set_child_property() and get_child_property() implementations.
 </para>
 
-@object: 
+@object: the #GObject on which set_child_property() or get_child_property() 
-@property_id: 
+   was called
-@pspec: 
+@property_id: the numeric id of the property
+@pspec: the #GParamSpec of the property
 
 
 <!-- ##### MACRO gtk_container_border_width ##### -->

docs/reference/gtk/tmpl/gtkentry.sgml

@@ -186,10 +186,6 @@ The #GtkEntry-struct struct contains only private data.
 
 </para>
 
-<para>
-Creates a new #GtkEntry widget.
-</para>
-
 <!-- ##### ARG GtkEntry:inner-border ##### -->
 <para>
 
@@ -213,54 +209,38 @@ Creates a new #GtkEntry widget.
 
 <!-- ##### FUNCTION gtk_entry_set_text ##### -->
 <para>
-Sets the text in the widget to the given
+
-value, replacing the current contents.
 </para>
 
-@entry: a #GtkEntry.
+@entry:
-@text: the new text.
+@text:
 
 
 <!-- ##### FUNCTION gtk_entry_append_text ##### -->
 <para>
-Appends the given text to the contents of the widget.
+
 </para>
 
-@entry: a #GtkEntry.
+@entry: 
-@text: the text to append.
+@text: 
-@Deprecated: gtk_entry_append_text() is deprecated and should not
-   be used in newly-written code. Use gtk_editable_insert_text()
-   instead.
 
 
 <!-- ##### FUNCTION gtk_entry_prepend_text ##### -->
 <para>
-Prepends the given text to the contents of the widget.
+
 </para>
 
-@entry: a #GtkEntry.
+@entry:
-@text: the text to prepend.
+@text:
-@Deprecated: gtk_entry_prepend_text() is deprecated and should not
-   be used in newly-written code. Use gtk_editable_insert_text()
-   instead.
 
 
 <!-- ##### FUNCTION gtk_entry_set_position ##### -->
 <para>
-Sets the cursor position in an entry to the given 
+
-value. This function is obsolete. You should use
-gtk_editable_set_position() instead.
 </para>
 
-@entry: a #GtkEntry.
+@entry: 
-@position: the position of the cursor. The cursor is displayed
+@position: 
-           before the character with the given (base 0) index
-           in the widget. The value must be less than or
-           equal to the number of characters in the widget.
-           A value of -1 indicates that the position should
-           be set after the last character in the entry.
-           Note that this position is in characters, not in
-           bytes.
 
 
 <!-- ##### FUNCTION gtk_entry_get_text ##### -->
@@ -274,36 +254,21 @@ gtk_editable_set_position() instead.
 
 <!-- ##### FUNCTION gtk_entry_select_region ##### -->
 <para>
-Selects a region of text. The characters that
+
-are selected are those characters at positions from
-@start_pos up to, but not including @end_pos. If 
-@end_pos is negative, then the the characters selected
-will be those characters from @start_pos to the end
-of the text. This function is obsolete. You should
-use gtk_editable_select_region() instead.
 </para>
 
-@entry: a #GtkEntry.
+@entry: 
-@start: the starting position.
+@start:
-@end: the end position.
+@end: 
 
 
 <!-- ##### FUNCTION gtk_entry_set_visibility ##### -->
 <para>
-Sets whether the contents of the entry are visible or
+
-not. When visibility is set to %FALSE, characters
-are displayed as the invisible char, and will also appear
-that way when the text in the entry widget is copied
-elsewhere.
-</para>
-<para>
-The default invisible char is the asterisk '*', but it can
-be changed with gtk_entry_set_invisible_char().
 </para>
 
-@entry: a #GtkEntry.
+@entry: 
-@visible: %TRUE if the contents of the entry are displayed
+@visible:
-          as plaintext.
 
 
 <!-- ##### FUNCTION gtk_entry_set_invisible_char ##### -->
@@ -317,14 +282,11 @@ be changed with gtk_entry_set_invisible_char().
 
 <!-- ##### FUNCTION gtk_entry_set_editable ##### -->
 <para>
-Determines if the user can edit the text in the editable
+
-widget or not. This function is obsolete. You should
-use gtk_editable_set_editable() instead.
 </para>
 
-@entry: a #GtkEntry.
+@entry: 
-@editable: %TRUE if the user is allowed to edit the text
+@editable: 
-  in the widget.
 
 
 <!-- ##### FUNCTION gtk_entry_set_max_length ##### -->

docs/reference/gtk/tmpl/gtkenums.sgml

@@ -78,13 +78,13 @@ contains. (See also: #GtkVButtonBox and #GtkHButtonBox).
 </para>
 
 @GTK_BUTTONBOX_DEFAULT_STYLE: Default packing.
-@GTK_BUTTONBOX_SPREAD: Buttons are evenly spread across the ButtonBox.
+@GTK_BUTTONBOX_SPREAD: Buttons are evenly spread across the box.
-@GTK_BUTTONBOX_EDGE: Buttons are placed at the edges of the ButtonBox.
+@GTK_BUTTONBOX_EDGE: Buttons are placed at the edges of the box.
-@GTK_BUTTONBOX_START: Buttons are grouped towards the start of box, (on the
+@GTK_BUTTONBOX_START: Buttons are grouped towards the start of the box, 
-left for a HBox, or the top for a VBox).
+  (on the left for a HBox, or the top for a VBox).
-@GTK_BUTTONBOX_END: Buttons are grouped towards the end of a box, (on the
+@GTK_BUTTONBOX_END: Buttons are grouped towards the end of the box, 
-right for a HBox, or the bottom for a VBox).
+  (on the right for a HBox, or the bottom for a VBox).
-@GTK_BUTTONBOX_CENTER: 
+@GTK_BUTTONBOX_CENTER: Buttons are centered in the box. Since 2.12 
 
 <!-- ##### ENUM GtkCornerType ##### -->
 <para>

docs/reference/gtk/tmpl/gtkfilechooser.sgml

@@ -672,6 +672,61 @@ gtk_widget_destroy (chooser);
 
 @filechooser: the object which received the signal.
 
+<!-- ##### ARG GtkFileChooser:action ##### -->
+<para>
+
+</para>
+
+<!-- ##### ARG GtkFileChooser:do-overwrite-confirmation ##### -->
+<para>
+
+</para>
+
+<!-- ##### ARG GtkFileChooser:extra-widget ##### -->
+<para>
+
+</para>
+
+<!-- ##### ARG GtkFileChooser:file-system-backend ##### -->
+<para>
+
+</para>
+
+<!-- ##### ARG GtkFileChooser:filter ##### -->
+<para>
+
+</para>
+
+<!-- ##### ARG GtkFileChooser:local-only ##### -->
+<para>
+
+</para>
+
+<!-- ##### ARG GtkFileChooser:preview-widget ##### -->
+<para>
+
+</para>
+
+<!-- ##### ARG GtkFileChooser:preview-widget-active ##### -->
+<para>
+
+</para>
+
+<!-- ##### ARG GtkFileChooser:select-multiple ##### -->
+<para>
+
+</para>
+
+<!-- ##### ARG GtkFileChooser:show-hidden ##### -->
+<para>
+
+</para>
+
+<!-- ##### ARG GtkFileChooser:use-preview-label ##### -->
+<para>
+
+</para>
+
 <!-- ##### ENUM GtkFileChooserAction ##### -->
     <para>
       Describes whether a #GtkFileChooser is being used to open
@@ -726,7 +781,8 @@ gtk_widget_destroy (chooser);
 
 @GTK_FILE_CHOOSER_ERROR_NONEXISTENT: Indicates that a file does not exist.
 @GTK_FILE_CHOOSER_ERROR_BAD_FILENAME: Indicates a malformed filename.
-@GTK_FILE_CHOOSER_ERROR_ALREADY_EXISTS: 
+@GTK_FILE_CHOOSER_ERROR_ALREADY_EXISTS: Indicates a duplicate path (e.g. when
+   adding a bookmark).
 
 <!-- ##### FUNCTION gtk_file_chooser_set_action ##### -->
 <para>

docs/reference/gtk/tmpl/gtklinkbutton.sgml

@@ -96,9 +96,7 @@ clicked.
 
 @button: the #GtkLinkButton which was clicked
 @link: the URI to which the clicked #GtkLinkButton points
-@user_data: 
+@user_data: user data that was passed when the function was registered
-<!-- # Unused Parameters # -->
-@data: user data that was passed when the function was registered
   with gtk_link_button_set_uri_hook()
 
 

gtk/gtkentry.c

@@ -4304,6 +4304,14 @@ gtk_entry_new_with_max_length (gint max)
   return GTK_WIDGET (entry);
 }
 
+/**
+ * gtk_entry_set_text:
+ * @entry: a #GtkEntry
+ * @text: the new text
+ *
+ * Sets the text in the widget to the given
+ * value, replacing the current contents.
+ */
 void
 gtk_entry_set_text (GtkEntry    *entry,
 		    const gchar *text)
@@ -4337,6 +4345,17 @@ gtk_entry_set_text (GtkEntry    *entry,
     g_signal_handler_unblock (entry, completion->priv->changed_id);
 }
 
+/**
+ * gtk_entry_append_text:
+ * @entry: a #GtkEntry
+ * @text: the text to append
+ *
+ * Appends the given text to the contents of the widget.
+ *
+ * Deprecated: gtk_entry_append_text() is deprecated and should not
+ *   be used in newly-written code. Use gtk_editable_insert_text()
+ *   instead.
+ */
 void
 gtk_entry_append_text (GtkEntry *entry,
 		       const gchar *text)
@@ -4350,6 +4369,17 @@ gtk_entry_append_text (GtkEntry *entry,
   gtk_editable_insert_text (GTK_EDITABLE (entry), text, -1, &tmp_pos);
 }
 
+/**
+ * gtk_entry_prepend_text:
+ * @entry: a #GtkEntry
+ * @text: the text to prepend
+ *
+ * Prepends the given text to the contents of the widget.
+ *
+ * Deprecated: gtk_entry_prepend_text() is deprecated and should not
+ *    be used in newly-written code. Use gtk_editable_insert_text()
+ *    instead.
+ */
 void
 gtk_entry_prepend_text (GtkEntry *entry,
 			const gchar *text)
@@ -4363,6 +4393,20 @@ gtk_entry_prepend_text (GtkEntry *entry,
   gtk_editable_insert_text (GTK_EDITABLE (entry), text, -1, &tmp_pos);
 }
 
+/**
+ * gtk_entry_set_position:
+ * @entry: a #GtkEntry
+ * @position:  the position of the cursor. The cursor is displayed
+ *    before the character with the given (base 0) index in the widget. 
+ *    The value must be less than or equal to the number of characters 
+ *    in the widget. A value of -1 indicates that the position should
+ *    be set after the last character in the entry. Note that this 
+ *    position is in characters, not in bytes.
+ *
+ * Sets the cursor position in an entry to the given value. 
+ *
+ * Deprecated: Use gtk_editable_set_position() instead.
+ */
 void
 gtk_entry_set_position (GtkEntry *entry,
 			gint       position)
@@ -4372,6 +4416,20 @@ gtk_entry_set_position (GtkEntry *entry,
   gtk_editable_set_position (GTK_EDITABLE (entry), position);
 }
 
+/**
+ * gtk_entry_set_visibility:
+ * @entry: a #GtkEntry
+ * @visible: %TRUE if the contents of the entry are displayed
+ *           as plaintext
+ *
+ * Sets whether the contents of the entry are visible or not. 
+ * When visibility is set to %FALSE, characters are displayed 
+ * as the invisible char, and will also appear that way when 
+ * the text in the entry widget is copied elsewhere.
+ *
+ * The default invisible char is the asterisk '*', but it can
+ * be changed with gtk_entry_set_invisible_char().
+ */
 void
 gtk_entry_set_visibility (GtkEntry *entry,
 			  gboolean visible)
@@ -4473,6 +4531,17 @@ gtk_entry_get_invisible_char (GtkEntry *entry)
   return entry->invisible_char;
 }
 
+/**
+ * gtk_entry_set_editable:
+ * @entry: a #GtkEntry
+ * @editable: %TRUE if the user is allowed to edit the text
+ *   in the widget
+ *
+ * Determines if the user can edit the text in the editable
+ * widget or not. 
+ *
+ * Deprecated: Use gtk_editable_set_editable() instead.
+ */
 void
 gtk_entry_set_editable (GtkEntry *entry,
 			gboolean  editable)
@@ -4502,6 +4571,20 @@ gtk_entry_get_text (GtkEntry *entry)
   return entry->text;
 }
 
+/**
+ * gtk_entry_select_region:
+ * @entry: a #GtkEntry
+ * @start: the starting position
+ * @end: the end position
+ *
+ * Selects a region of text. The characters that are selected are 
+ * those characters at positions from @start_pos up to, but not 
+ * including @end_pos. If @end_pos is negative, then the the characters 
+ * selected will be those characters from @start_pos to the end of 
+ * the text. 
+ *
+ * Deprecated: Use gtk_editable_select_region() instead.
+ */
 void       
 gtk_entry_select_region  (GtkEntry       *entry,
 			  gint            start,