From 4336f5447b6f5c53b8ef0682c82a39b8bce9e054 Mon Sep 17 00:00:00 2001 From: Shane Landrum Date: Sat, 28 Aug 2004 03:46:45 +0000 Subject: [PATCH] 2004-08-28 Shane Landrum * en/Gtk/TranslateFunc.xml: delegate docs. * en/Gtk/Settings*.xml: settings classes docs, first pass. * en/Gtk/Separator.xml: Documented protected constructor. * en/Gtk/StockItem.xml: Documented translation domain. * en/Gtk/Ruler.xml: Documented Ruler class. * en/Gtk/SpinButton.xml: Documented SpinButton class. * en/Gtk/TextMarkBody.xml: Internal class, do not use. * en/Gtk/Submenu.xml: Documented submenus. * en/Gtk/ItemFactory.xml * en/Gtk/WindowKeysForeachFunc.xml * en/Gtk/SurroundingDeletedArgs.xml: Added docs. svn path=/trunk/gtk-sharp/; revision=32963 --- doc/ChangeLog | 14 +++++ doc/en/Gtk/ItemFactory.xml | 14 ++--- doc/en/Gtk/Ruler.xml | 62 +++++++++---------- doc/en/Gtk/Separator.xml | 6 +- doc/en/Gtk/Settings.xml | 86 +++++++++++++-------------- doc/en/Gtk/SettingsPropertyValue.xml | 6 +- doc/en/Gtk/SettingsValue.xml | 26 ++++---- doc/en/Gtk/SpinButton.xml | 50 ++++++++-------- doc/en/Gtk/StockItem.xml | 6 +- doc/en/Gtk/Submenu.xml | 18 +++--- doc/en/Gtk/SurroundingDeletedArgs.xml | 14 ++--- doc/en/Gtk/TextMarkBody.xml | 6 +- doc/en/Gtk/TranslateFunc.xml | 6 +- doc/en/Gtk/WindowKeysForeachFunc.xml | 4 +- 14 files changed, 166 insertions(+), 152 deletions(-) diff --git a/doc/ChangeLog b/doc/ChangeLog index 35f242b54..7117b9b89 100644 --- a/doc/ChangeLog +++ b/doc/ChangeLog @@ -1,3 +1,17 @@ +2004-08-28 Shane Landrum + + * en/Gtk/TranslateFunc.xml: delegate docs. + * en/Gtk/Settings*.xml: settings classes docs, first pass. + * en/Gtk/Separator.xml: Documented protected constructor. + * en/Gtk/StockItem.xml: Documented translation domain. + * en/Gtk/Ruler.xml: Documented Ruler class. + * en/Gtk/SpinButton.xml: Documented SpinButton class. + * en/Gtk/TextMarkBody.xml: Internal class, do not use. + * en/Gtk/Submenu.xml: Documented submenus. + * en/Gtk/ItemFactory.xml + * en/Gtk/WindowKeysForeachFunc.xml + * en/Gtk/SurroundingDeletedArgs.xml: Added docs. + 2004-08-27 Shane Landrum * en/Gtk/Style.xml: bugfixes, more docs. diff --git a/doc/en/Gtk/ItemFactory.xml b/doc/en/Gtk/ItemFactory.xml index 80daae0a6..0cf7dc11f 100644 --- a/doc/en/Gtk/ItemFactory.xml +++ b/doc/en/Gtk/ItemFactory.xml @@ -138,9 +138,9 @@ Obtains the menu item which correponds to . - To be added: an object of type 'uint' - To be added: an object of type 'Gtk.Widget' - To be added + A (TODO: where is this enumerated?) + A + @@ -188,9 +188,9 @@ Obtains the which corresponds to . - To be added: an object of type 'uint' - To be added: an object of type 'Gtk.Widget' - To be added + A (TODO: where is this enumerated?) + A + @@ -477,4 +477,4 @@ - \ No newline at end of file + diff --git a/doc/en/Gtk/Ruler.xml b/doc/en/Gtk/Ruler.xml index 311c234ed..42c93d008 100644 --- a/doc/en/Gtk/Ruler.xml +++ b/doc/en/Gtk/Ruler.xml @@ -44,8 +44,8 @@ - To be added - To be added + Draws tickmarks on the ruler. + @@ -56,8 +56,8 @@ - To be added - To be added + Draws the mouse position mark on the ruler. + @@ -77,8 +77,8 @@ The lower value to display on the Ruler. The upper value to display on the Ruler. The current position of the mouse aligned with this Ruler. - To be added: an object of type 'double' - To be added + A , the maximum size of the ruler. + @@ -94,12 +94,12 @@ - To be added - To be added: an object of type 'double&' - To be added: an object of type 'double&' - To be added: an object of type 'double&' - To be added: an object of type 'double&' - To be added + Gets the range information. + A for the lower value to display on the Ruler. + A for the upper value to display on the Ruler. + A for the current position of the mouse aligned with this Ruler. + A , the maximum size of the ruler. + @@ -156,10 +156,10 @@ - To be added - To be added: an object of type 'double' - To be added: an object of type 'double' - To be added + The upper value to display on the ruler. + A + A + @@ -171,10 +171,10 @@ - To be added - To be added: an object of type 'double' - To be added: an object of type 'double' - To be added + The position of the mouse mark on the ruler. + A + A + @@ -186,10 +186,10 @@ - To be added - To be added: an object of type 'double' - To be added: an object of type 'double' - To be added + The maximum size of the ruler. + A + A + @@ -201,10 +201,10 @@ - To be added - To be added: an object of type 'double' - To be added: an object of type 'double' - To be added + The lower limit of the ruler. + A + A + @@ -240,10 +240,10 @@ - To be added + Protected constructor. a - To be added + - \ No newline at end of file + diff --git a/doc/en/Gtk/Separator.xml b/doc/en/Gtk/Separator.xml index b5a417e68..6663aa682 100644 --- a/doc/en/Gtk/Separator.xml +++ b/doc/en/Gtk/Separator.xml @@ -93,10 +93,10 @@ - To be added + Protected constructor. a - To be added + - \ No newline at end of file + diff --git a/doc/en/Gtk/Settings.xml b/doc/en/Gtk/Settings.xml index 2fd278961..ca5e8a3ce 100644 --- a/doc/en/Gtk/Settings.xml +++ b/doc/en/Gtk/Settings.xml @@ -10,8 +10,8 @@ Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. - To be added - To be added + Maintains application settings for objects attached to a toplevel. + See GLib.Object @@ -37,10 +37,10 @@ - To be added - To be added: an object of type 'IntPtr' - To be added: an object of type 'Gtk.RcPropertyParser' - To be added + Sets up the property parser for reading Rc files. + A , pointer to the underlying C object (TODO: explain) + A + @@ -54,8 +54,8 @@ To be added - To be added: an object of type 'IntPtr' - To be added + A + @@ -71,10 +71,10 @@ To be added - To be added: an object of type 'string' - To be added: an object of type 'long' - To be added: an object of type 'string' - To be added + A + A + A + @@ -89,9 +89,9 @@ To be added - To be added: an object of type 'string' - To be added: an object of type 'Gtk.SettingsValue' - To be added + A + A + @@ -107,10 +107,10 @@ To be added - To be added: an object of type 'string' - To be added: an object of type 'double' - To be added: an object of type 'string' - To be added + A + A + A + @@ -126,10 +126,10 @@ To be added - To be added: an object of type 'string' - To be added: an object of type 'string' - To be added: an object of type 'string' - To be added + A + A + A + @@ -167,9 +167,9 @@ Gtk.Settings - To be added - To be added: an object of type 'Gtk.Settings' - To be added + Returns a default settings object. + A + @@ -185,7 +185,7 @@ To be added a a - To be added + @@ -223,9 +223,9 @@ - To be added + True if the cursor should blink, false if it should not blink. a - To be added + @@ -236,9 +236,9 @@ - To be added + Blink interval in milliseconds for the cursor. a - To be added + @@ -251,7 +251,7 @@ To be added a - To be added + @@ -262,9 +262,9 @@ - To be added + Maximum interval between clicks for a mouse action to be considered a double-click. Measured in milliseconds. a - To be added + @@ -277,7 +277,7 @@ To be added a - To be added + @@ -290,7 +290,7 @@ To be added a - To be added + @@ -303,7 +303,7 @@ To be added a - To be added + @@ -316,7 +316,7 @@ To be added a - To be added + @@ -329,7 +329,7 @@ To be added a - To be added + @@ -342,7 +342,7 @@ To be added a - To be added + @@ -351,10 +351,10 @@ - To be added + Default constructor. a - To be added + - \ No newline at end of file + diff --git a/doc/en/Gtk/SettingsPropertyValue.xml b/doc/en/Gtk/SettingsPropertyValue.xml index 9a7f5c2d8..b5b29ec78 100644 --- a/doc/en/Gtk/SettingsPropertyValue.xml +++ b/doc/en/Gtk/SettingsPropertyValue.xml @@ -10,8 +10,8 @@ Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. - To be added - To be added + A value for a property. + GLib.Opaque @@ -38,4 +38,4 @@ - \ No newline at end of file + diff --git a/doc/en/Gtk/SettingsValue.xml b/doc/en/Gtk/SettingsValue.xml index 42a05f64a..744f324dd 100644 --- a/doc/en/Gtk/SettingsValue.xml +++ b/doc/en/Gtk/SettingsValue.xml @@ -10,8 +10,8 @@ Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. - To be added - To be added + Data for . + System.ValueType @@ -27,8 +27,8 @@ - To be added - To be added + An empty value. + @@ -41,10 +41,10 @@ - To be added - To be added: an object of type 'IntPtr' - To be added: an object of type 'Gtk.SettingsValue' - To be added + Constructor. + A , pointer to the underlying C object. + A + Not for general developer use. @@ -56,8 +56,8 @@ - To be added - To be added + The source of this data (usually an rcfile). + @@ -69,9 +69,9 @@ - To be added - To be added + The data value. + - \ No newline at end of file + diff --git a/doc/en/Gtk/SpinButton.xml b/doc/en/Gtk/SpinButton.xml index 4d1046901..a234821a7 100644 --- a/doc/en/Gtk/SpinButton.xml +++ b/doc/en/Gtk/SpinButton.xml @@ -229,11 +229,11 @@ private void OutputValue(object source, System.EventArgs args) Creates a new SpinButton based on the specified . - To be added: an object of type 'Gtk.Adjustment' - To be added: an object of type 'double' - To be added: an object of type 'uint' - To be added: an object of type 'Gtk.SpinButton' - To be added + A + A + A + A + @@ -295,10 +295,10 @@ private void OutputValue(object source, System.EventArgs args) - To be added - To be added: an object of type 'double' - To be added: an object of type 'double' - To be added + The acceleration rate when user holds down a button. + A + A + @@ -379,10 +379,10 @@ private void OutputValue(object source, System.EventArgs args) - To be added - To be added: an object of type 'Gtk.SpinButtonUpdatePolicy' - To be added: an object of type 'Gtk.SpinButtonUpdatePolicy' - To be added + The policy for how to update this SpinButton when its value changes. + A + A + @@ -394,10 +394,10 @@ private void OutputValue(object source, System.EventArgs args) - To be added - To be added: an object of type 'Gtk.Adjustment' - To be added: an object of type 'Gtk.Adjustment' - To be added + The lower/upper/step range of this widget's values. + A + A + @@ -408,8 +408,8 @@ private void OutputValue(object source, System.EventArgs args) - To be added - To be added + Fired when this widget outputs its value. + @@ -420,7 +420,7 @@ private void OutputValue(object source, System.EventArgs args) - This event is fired when the SpinButton's value changes. + This event is fired after the SpinButton's value changes. @@ -432,8 +432,8 @@ private void OutputValue(object source, System.EventArgs args) - To be added - To be added + Fired when the user inputs a new value. + @@ -444,8 +444,8 @@ private void OutputValue(object source, System.EventArgs args) - To be added - To be added + Fired in order to change the button's value. + @@ -532,4 +532,4 @@ private void OutputValue(object source, System.EventArgs args) - \ No newline at end of file + diff --git a/doc/en/Gtk/StockItem.xml b/doc/en/Gtk/StockItem.xml index c739f4571..3c16161ee 100644 --- a/doc/en/Gtk/StockItem.xml +++ b/doc/en/Gtk/StockItem.xml @@ -136,9 +136,9 @@ - To be added - To be added + Specifies the translation domain for this item, for use in globalization. + - \ No newline at end of file + diff --git a/doc/en/Gtk/Submenu.xml b/doc/en/Gtk/Submenu.xml index 2a88e280f..20810df97 100644 --- a/doc/en/Gtk/Submenu.xml +++ b/doc/en/Gtk/Submenu.xml @@ -10,8 +10,8 @@ Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. - To be added - To be added + A menu that pops out from another menu; see . + TODO: show an example. System.Object @@ -25,9 +25,9 @@ - To be added + Default constructor. a - To be added + @@ -38,9 +38,9 @@ - To be added + The placement of this submenu. a - To be added + @@ -51,10 +51,10 @@ - To be added + The direction this menu pops out. a - To be added + - \ No newline at end of file + diff --git a/doc/en/Gtk/SurroundingDeletedArgs.xml b/doc/en/Gtk/SurroundingDeletedArgs.xml index 115386909..2c9647cf1 100644 --- a/doc/en/Gtk/SurroundingDeletedArgs.xml +++ b/doc/en/Gtk/SurroundingDeletedArgs.xml @@ -39,9 +39,9 @@ System.Int32 - To be added - To be added: an object of type 'int' - To be added + The number of characters that were deleted. + A . + @@ -51,10 +51,10 @@ System.Int32 - To be added - To be added: an object of type 'int' - To be added + The offset the characters were deleted near. + A + - \ No newline at end of file + diff --git a/doc/en/Gtk/TextMarkBody.xml b/doc/en/Gtk/TextMarkBody.xml index 57552d4cc..0bce25115 100644 --- a/doc/en/Gtk/TextMarkBody.xml +++ b/doc/en/Gtk/TextMarkBody.xml @@ -10,8 +10,8 @@ Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. - To be added - To be added + Do not use. + TODO: Can this document be deleted? GLib.Opaque @@ -40,4 +40,4 @@ - \ No newline at end of file + diff --git a/doc/en/Gtk/TranslateFunc.xml b/doc/en/Gtk/TranslateFunc.xml index 225f11643..093ceb4d0 100644 --- a/doc/en/Gtk/TranslateFunc.xml +++ b/doc/en/Gtk/TranslateFunc.xml @@ -7,8 +7,8 @@ Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. - To be added - To be added + Delegate used by to translate path elements before they are displayed. + TODO: Add an example here. System.Delegate @@ -29,4 +29,4 @@ System.String - \ No newline at end of file + diff --git a/doc/en/Gtk/WindowKeysForeachFunc.xml b/doc/en/Gtk/WindowKeysForeachFunc.xml index c7bf7cdbc..b7cf6ae9d 100644 --- a/doc/en/Gtk/WindowKeysForeachFunc.xml +++ b/doc/en/Gtk/WindowKeysForeachFunc.xml @@ -7,8 +7,8 @@ Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. - Delegate for use by - To be added + Delegate class. + TODO: There are no references to this class elsewhere in the doc; is it obsolete? System.Delegate