From 8855f7a5a7bbbfe0bdbb9c9eef4c1ffc5694ceb9 Mon Sep 17 00:00:00 2001 From: John Luke Date: Fri, 22 Apr 2005 17:20:16 +0000 Subject: [PATCH] add some automatic docs for the new stuff svn path=/trunk/gtk-sharp/; revision=43452 --- doc/ChangeLog | 5 ++ doc/en/Atk/BoundsChangedArgs.xml | 12 +-- doc/en/Atk/BoundsChangedHandler.xml | 8 +- doc/en/Atk/NoOpObject.xml | 4 +- doc/en/Gdk/PangoRenderer.xml | 17 ++-- doc/en/Gtk/AboutDialog.xml | 17 ++-- doc/en/Gtk/AccelGroup.xml | 6 +- doc/en/Gtk/Action.xml | 2 +- doc/en/Gtk/ActionActivatedArgs.xml | 6 +- doc/en/Gtk/ActivateCursorItemArgs.xml | 12 +-- doc/en/Gtk/ActivateCursorItemHandler.xml | 8 +- doc/en/Gtk/Alignment.xml | 22 +++-- doc/en/Gtk/ButtonBox.xml | 25 +++--- doc/en/Gtk/Calendar.xml | 31 ++++--- doc/en/Gtk/CellRenderer.xml | 4 +- doc/en/Gtk/CellRendererCombo.xml | 17 ++-- doc/en/Gtk/CellRendererProgress.xml | 17 ++-- doc/en/Gtk/CheckMenuItem.xml | 13 +-- doc/en/Gtk/Clipboard.xml | 4 +- doc/en/Gtk/ComboBox.xml | 8 +- doc/en/Gtk/Container.xml | 22 ++--- doc/en/Gtk/DisconnectProxyArgs.xml | 8 +- doc/en/Gtk/EditingStartedArgs.xml | 12 +-- doc/en/Gtk/EditingStartedHandler.xml | 8 +- doc/en/Gtk/Entry.xml | 4 +- doc/en/Gtk/EntryCompletion.xml | 6 +- doc/en/Gtk/EventBox.xml | 8 +- doc/en/Gtk/FileChooserButton.xml | 17 ++-- doc/en/Gtk/FontButton.xml | 40 +++++---- doc/en/Gtk/IMContext.xml | 23 +++-- doc/en/Gtk/IMContextSimple.xml | 10 +-- doc/en/Gtk/IconView.xml | 49 +++++----- doc/en/Gtk/Item.xml | 7 +- doc/en/Gtk/ItemActivatedArgs.xml | 12 +-- doc/en/Gtk/ItemActivatedHandler.xml | 8 +- doc/en/Gtk/MatchSelectedArgs.xml | 8 +- doc/en/Gtk/MenuToolButton.xml | 21 ++--- doc/en/Gtk/NoExposeEventArgs.xml | 7 +- doc/en/Gtk/Object.xml | 58 +++++++----- doc/en/Gtk/OwnerChangeArgs.xml | 12 +-- doc/en/Gtk/OwnerChangeHandler.xml | 8 +- doc/en/Gtk/Paned.xml | 15 ++-- doc/en/Gtk/Plug.xml | 24 ++--- doc/en/Gtk/PopupContextMenuArgs.xml | 11 ++- doc/en/Gtk/PostActivateArgs.xml | 5 +- doc/en/Gtk/PrefixInsertedArgs.xml | 12 +-- doc/en/Gtk/PrefixInsertedHandler.xml | 8 +- doc/en/Gtk/RadioAction.xml | 2 +- doc/en/Gtk/Range.xml | 4 +- doc/en/Gtk/RetrieveSurroundingHandler.xml | 3 +- doc/en/Gtk/Scale.xml | 7 +- doc/en/Gtk/Style.xml | 2 +- doc/en/Gtk/TextView.xml | 4 +- doc/en/Gtk/ToggleAction.xml | 29 +++--- doc/en/Gtk/TreeModelFilter.xml | 4 +- doc/en/Gtk/TreeSelection.xml | 2 +- doc/en/Gtk/Widget.xml | 4 +- doc/en/Pango/FcDecoder.xml | 17 ++-- doc/en/Pango/Renderer.xml | 17 ++-- doc/en/Pango/XftRenderer.xml | 17 ++-- doc/gen-finalize-docs.cs | 103 ---------------------- doc/gen-gtype-docs.cs | 103 ---------------------- 62 files changed, 442 insertions(+), 537 deletions(-) diff --git a/doc/ChangeLog b/doc/ChangeLog index 56e977836..50a189abe 100644 --- a/doc/ChangeLog +++ b/doc/ChangeLog @@ -1,3 +1,8 @@ +2005-04-22 John Luke + + * en/*/*.xml: run gen*.exe to fill in some docs + on the new gtk, atk, gdk, and pango stuff for 2.6 + 2005-04-08 Dan Winship * en/Gtk/Container.xml: document new children stuff diff --git a/doc/en/Atk/BoundsChangedArgs.xml b/doc/en/Atk/BoundsChangedArgs.xml index 055a6dbc4..915c958b2 100644 --- a/doc/en/Atk/BoundsChangedArgs.xml +++ b/doc/en/Atk/BoundsChangedArgs.xml @@ -9,8 +9,10 @@ Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. - To be added - To be added + Event data. + + The event invokes delegates which pass event data via this class. + GLib.SignalArgs @@ -24,9 +26,9 @@ - To be added - a - To be added + Public Constructor. + A new . + Create a new instance with this constructor if you need to invoke a delegate. diff --git a/doc/en/Atk/BoundsChangedHandler.xml b/doc/en/Atk/BoundsChangedHandler.xml index 091a8c021..fbce4c506 100644 --- a/doc/en/Atk/BoundsChangedHandler.xml +++ b/doc/en/Atk/BoundsChangedHandler.xml @@ -9,8 +9,12 @@ Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. - To be added - To be added + Event handler. + + The event utilizes this delegate: + Event data is passed via the parameter. + To attach a to an event, add the BoundsChangedHandler instance to the event. The methods referenced by the BoundsChangedHandler instance are invoked whenever the event is raised, until the BoundsChangedHandler is removed from the event. + System.Delegate diff --git a/doc/en/Atk/NoOpObject.xml b/doc/en/Atk/NoOpObject.xml index d4d70afcb..abce17078 100644 --- a/doc/en/Atk/NoOpObject.xml +++ b/doc/en/Atk/NoOpObject.xml @@ -1931,9 +1931,9 @@ - To be added + Default handler for the event. a - To be added + Override this method in a subclass to provide a default handler for the event. diff --git a/doc/en/Gdk/PangoRenderer.xml b/doc/en/Gdk/PangoRenderer.xml index 13fe27e23..7c0b7d2ce 100644 --- a/doc/en/Gdk/PangoRenderer.xml +++ b/doc/en/Gdk/PangoRenderer.xml @@ -49,8 +49,9 @@ - To be added - To be added + Disposes the resources associated with this object. + + @@ -95,10 +96,10 @@ - To be added + Protected Constructor. a a - To be added + Chain to this constructor if you have manually registered a native value for your subclass. @@ -109,10 +110,10 @@ - To be added + Internal constructor a a - To be added + This is not typically used by C# code. @@ -137,9 +138,9 @@ - To be added + GType Property. a - To be added + Returns the native value for . diff --git a/doc/en/Gtk/AboutDialog.xml b/doc/en/Gtk/AboutDialog.xml index a23675152..837280add 100644 --- a/doc/en/Gtk/AboutDialog.xml +++ b/doc/en/Gtk/AboutDialog.xml @@ -39,8 +39,9 @@ - To be added - To be added + Disposes the resources associated with this object. + + @@ -51,10 +52,10 @@ - To be added + Protected Constructor. a a - To be added + Chain to this constructor if you have manually registered a native value for your subclass. @@ -65,10 +66,10 @@ - To be added + Internal constructor a a - To be added + This is not typically used by C# code. @@ -90,9 +91,9 @@ - To be added + GType Property. a - To be added + Returns the native value for . diff --git a/doc/en/Gtk/AccelGroup.xml b/doc/en/Gtk/AccelGroup.xml index ddf250cf5..b496bb3d5 100644 --- a/doc/en/Gtk/AccelGroup.xml +++ b/doc/en/Gtk/AccelGroup.xml @@ -339,8 +339,10 @@ - - + + + + diff --git a/doc/en/Gtk/Action.xml b/doc/en/Gtk/Action.xml index 912a93fc4..03b59711b 100644 --- a/doc/en/Gtk/Action.xml +++ b/doc/en/Gtk/Action.xml @@ -574,4 +574,4 @@ This does not necessarily mean effective visibility. See - See - and + See + and for more context about the index property. - + \ No newline at end of file diff --git a/doc/en/Gtk/ActivateCursorItemArgs.xml b/doc/en/Gtk/ActivateCursorItemArgs.xml index 9108a5a65..8f7e07b79 100644 --- a/doc/en/Gtk/ActivateCursorItemArgs.xml +++ b/doc/en/Gtk/ActivateCursorItemArgs.xml @@ -9,8 +9,10 @@ Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. - To be added - To be added + Event data. + + The event invokes delegates which pass event data via this class. + GLib.SignalArgs @@ -24,9 +26,9 @@ - To be added - a - To be added + Public Constructor. + A new . + Create a new instance with this constructor if you need to invoke a delegate. diff --git a/doc/en/Gtk/ActivateCursorItemHandler.xml b/doc/en/Gtk/ActivateCursorItemHandler.xml index a57850132..4da84369f 100644 --- a/doc/en/Gtk/ActivateCursorItemHandler.xml +++ b/doc/en/Gtk/ActivateCursorItemHandler.xml @@ -9,8 +9,12 @@ Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. - To be added - To be added + Event handler. + + The event utilizes this delegate: + Event data is passed via the parameter. + To attach a to an event, add the ActivateCursorItemHandler instance to the event. The methods referenced by the ActivateCursorItemHandler instance are invoked whenever the event is raised, until the ActivateCursorItemHandler is removed from the event. + System.Delegate diff --git a/doc/en/Gtk/Alignment.xml b/doc/en/Gtk/Alignment.xml index 3bc67251b..4bc84c3ab 100644 --- a/doc/en/Gtk/Alignment.xml +++ b/doc/en/Gtk/Alignment.xml @@ -213,7 +213,8 @@ The padding to insert at the left of the child widget. a - + + @@ -226,7 +227,8 @@ The padding to insert at the bottom of the child widget. a - + + @@ -239,7 +241,8 @@ The padding to insert at the top of the child widget. a - + + @@ -252,7 +255,8 @@ The padding to insert at the right of the child widget. a - + + @@ -276,7 +280,7 @@ a a This is a convenience method. - See also . + See also . @@ -300,17 +304,17 @@ a a - + The padding adds blank space to the vertical or horizontal sides of the widget. For instance, this can be used to indent the child widget towards the right by adding padding on the left. - + This is a convenience method; the properties can also be set directly. - + - + \ No newline at end of file diff --git a/doc/en/Gtk/ButtonBox.xml b/doc/en/Gtk/ButtonBox.xml index fd75c7681..fc205b587 100644 --- a/doc/en/Gtk/ButtonBox.xml +++ b/doc/en/Gtk/ButtonBox.xml @@ -144,7 +144,8 @@ Gets the internal padding of the child widgets. a , the horizontal value a , the vertical value - + + @@ -164,7 +165,8 @@ a a - + + @@ -181,7 +183,8 @@ Sets the internal padding of the child widgets. a , the horizontal value a , the vertical value - + + @@ -195,13 +198,14 @@ - + Sets the minimum width and height of this button box's child widgets. a a - + + @@ -230,10 +234,11 @@ - Returns whether should appear in a secondary group of children. + Returns whether should appear in a secondary group of children. a a - + + @@ -248,12 +253,12 @@ - Sets whether should appear in a secondary group of children. + Sets whether should appear in a secondary group of children. A typical use of a secondary child is the help button in a dialog. a a : if - , the appears in a secondary group of the button box. + , the appears in a secondary group of the button box. This group appears after the other children if the style @@ -274,4 +279,4 @@ - + \ No newline at end of file diff --git a/doc/en/Gtk/Calendar.xml b/doc/en/Gtk/Calendar.xml index 8f4ee9299..62317ca07 100644 --- a/doc/en/Gtk/Calendar.xml +++ b/doc/en/Gtk/Calendar.xml @@ -474,7 +474,8 @@ void HandleDaySelected (object obj, EventArgs args) The selected day as a number between 1 and 31, or 0 to unselect the currently selected day. a - + + @@ -485,9 +486,10 @@ void HandleDaySelected (object obj, EventArgs args) - If , week numbers are displayed + If , week numbers are displayed a - + + @@ -498,9 +500,10 @@ void HandleDaySelected (object obj, EventArgs args) - If , day names are displayed. + If , day names are displayed. a - + + @@ -511,9 +514,10 @@ void HandleDaySelected (object obj, EventArgs args) - If , a heading is displayed + If , a heading is displayed a - + + @@ -526,7 +530,8 @@ void HandleDaySelected (object obj, EventArgs args) The selected month as a number between 0 and 11. a - + + @@ -539,7 +544,8 @@ void HandleDaySelected (object obj, EventArgs args) The selected year. a - + + @@ -550,9 +556,10 @@ void HandleDaySelected (object obj, EventArgs args) - If , the selected month can not be changed. + If , the selected month can not be changed. a - + + @@ -571,4 +578,4 @@ void HandleDaySelected (object obj, EventArgs args) - + \ No newline at end of file diff --git a/doc/en/Gtk/CellRenderer.xml b/doc/en/Gtk/CellRenderer.xml index 42e3ac7c4..d20d9895c 100644 --- a/doc/en/Gtk/CellRenderer.xml +++ b/doc/en/Gtk/CellRenderer.xml @@ -539,10 +539,10 @@ - To be added + Default handler for the event. a a - To be added + Override this method in a subclass to provide a default handler for the event. diff --git a/doc/en/Gtk/CellRendererCombo.xml b/doc/en/Gtk/CellRendererCombo.xml index 0066ccae4..f5d1f08b9 100644 --- a/doc/en/Gtk/CellRendererCombo.xml +++ b/doc/en/Gtk/CellRendererCombo.xml @@ -33,8 +33,9 @@ - To be added - To be added + Disposes the resources associated with this object. + + @@ -45,10 +46,10 @@ - To be added + Protected Constructor. a a - To be added + Chain to this constructor if you have manually registered a native value for your subclass. @@ -59,10 +60,10 @@ - To be added + Internal constructor a a - To be added + This is not typically used by C# code. @@ -84,9 +85,9 @@ - To be added + GType Property. a - To be added + Returns the native value for . diff --git a/doc/en/Gtk/CellRendererProgress.xml b/doc/en/Gtk/CellRendererProgress.xml index 80385f7ca..ca690ce1f 100644 --- a/doc/en/Gtk/CellRendererProgress.xml +++ b/doc/en/Gtk/CellRendererProgress.xml @@ -33,8 +33,9 @@ - To be added - To be added + Disposes the resources associated with this object. + + @@ -45,10 +46,10 @@ - To be added + Protected Constructor. a a - To be added + Chain to this constructor if you have manually registered a native value for your subclass. @@ -59,10 +60,10 @@ - To be added + Internal constructor a a - To be added + This is not typically used by C# code. @@ -84,9 +85,9 @@ - To be added + GType Property. a - To be added + Returns the native value for . diff --git a/doc/en/Gtk/CheckMenuItem.xml b/doc/en/Gtk/CheckMenuItem.xml index 1b7421c18..6f8b689f3 100644 --- a/doc/en/Gtk/CheckMenuItem.xml +++ b/doc/en/Gtk/CheckMenuItem.xml @@ -202,7 +202,8 @@ Whether the menu item looks like a radio menu item. a - + + @@ -214,7 +215,8 @@ Whether this menu item can be toggled. a - + + @@ -225,9 +227,10 @@ - Fires the event. - + Fires the event. + + - + \ No newline at end of file diff --git a/doc/en/Gtk/Clipboard.xml b/doc/en/Gtk/Clipboard.xml index f2ec553e6..b3f22e19e 100644 --- a/doc/en/Gtk/Clipboard.xml +++ b/doc/en/Gtk/Clipboard.xml @@ -391,9 +391,9 @@ - To be added + Default handler for the event. a - To be added + Override this method in a subclass to provide a default handler for the event. diff --git a/doc/en/Gtk/ComboBox.xml b/doc/en/Gtk/ComboBox.xml index db7885fac..52faf00f7 100644 --- a/doc/en/Gtk/ComboBox.xml +++ b/doc/en/Gtk/ComboBox.xml @@ -726,8 +726,8 @@ Default value: 0 - To be added - To be added + Default handler for the event. + Override this method in a subclass to provide a default handler for the event. @@ -738,8 +738,8 @@ Default value: 0 - To be added - To be added + Default handler for the event. + Override this method in a subclass to provide a default handler for the event. diff --git a/doc/en/Gtk/Container.xml b/doc/en/Gtk/Container.xml index 7183b1b71..703b21a46 100644 --- a/doc/en/Gtk/Container.xml +++ b/doc/en/Gtk/Container.xml @@ -535,24 +535,24 @@ Obtains an array of the container's (non-internal) children. An array of non-internal children. - + Returns the container's non-internal children; that is, generally, the children that were explicitly added to the container by the application, as opposed to those widgets that are internal implementation details of the container. - + If you simply want to do a loop on the container's children, you do not need to use the Children property. Just do: - - + + foreach (Widget w in myContainer) { // Do something with w } - + @@ -567,19 +567,19 @@ foreach (Widget w in myContainer) { Returns an for the container's children a - - implements + + implements , so you can iterate through its children like this: - - + + foreach (Widget w in myContainer) { // Do something with w } - - + + diff --git a/doc/en/Gtk/DisconnectProxyArgs.xml b/doc/en/Gtk/DisconnectProxyArgs.xml index 8e315a9f2..236cdfc7f 100644 --- a/doc/en/Gtk/DisconnectProxyArgs.xml +++ b/doc/en/Gtk/DisconnectProxyArgs.xml @@ -41,7 +41,8 @@ The action being disconnected from a proxy. a - + + @@ -54,8 +55,9 @@ The proxy from which an action is being disconnected. a - + + - + \ No newline at end of file diff --git a/doc/en/Gtk/EditingStartedArgs.xml b/doc/en/Gtk/EditingStartedArgs.xml index f327ee616..800c21bf9 100644 --- a/doc/en/Gtk/EditingStartedArgs.xml +++ b/doc/en/Gtk/EditingStartedArgs.xml @@ -9,8 +9,10 @@ Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. - To be added - To be added + Event data. + + The event invokes delegates which pass event data via this class. + GLib.SignalArgs @@ -24,9 +26,9 @@ - To be added - a - To be added + Public Constructor. + A new . + Create a new instance with this constructor if you need to invoke a delegate. diff --git a/doc/en/Gtk/EditingStartedHandler.xml b/doc/en/Gtk/EditingStartedHandler.xml index 21e5fc4b9..0956cae48 100644 --- a/doc/en/Gtk/EditingStartedHandler.xml +++ b/doc/en/Gtk/EditingStartedHandler.xml @@ -9,8 +9,12 @@ Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. - To be added - To be added + Event handler. + + The event utilizes this delegate: + Event data is passed via the parameter. + To attach a to an event, add the EditingStartedHandler instance to the event. The methods referenced by the EditingStartedHandler instance are invoked whenever the event is raised, until the EditingStartedHandler is removed from the event. + System.Delegate diff --git a/doc/en/Gtk/Entry.xml b/doc/en/Gtk/Entry.xml index 92c052b74..6a29b7530 100644 --- a/doc/en/Gtk/Entry.xml +++ b/doc/en/Gtk/Entry.xml @@ -1138,8 +1138,8 @@ The horizontal alignment, from 0 (left) to 1 (right). Reversed for RTL layouts - To be added - To be added + Default handler for the event. + Override this method in a subclass to provide a default handler for the event. diff --git a/doc/en/Gtk/EntryCompletion.xml b/doc/en/Gtk/EntryCompletion.xml index 57fbf7d4f..02c502f4b 100644 --- a/doc/en/Gtk/EntryCompletion.xml +++ b/doc/en/Gtk/EntryCompletion.xml @@ -565,10 +565,10 @@ public class DemoEntryCompletion : Window - To be added + Default handler for the event. a a - To be added + Override this method in a subclass to provide a default handler for the event. @@ -584,4 +584,4 @@ public class DemoEntryCompletion : Window - + \ No newline at end of file diff --git a/doc/en/Gtk/EventBox.xml b/doc/en/Gtk/EventBox.xml index 69d614b7c..a03a25f0f 100644 --- a/doc/en/Gtk/EventBox.xml +++ b/doc/en/Gtk/EventBox.xml @@ -167,7 +167,8 @@ public class eventbox Whether the event-trapping window of the eventbox is above the window of the child widget as opposed to below it. a - + + @@ -180,8 +181,9 @@ public class eventbox Whether the event box is visible, as opposed to invisible and only used to trap events. a - + + - + \ No newline at end of file diff --git a/doc/en/Gtk/FileChooserButton.xml b/doc/en/Gtk/FileChooserButton.xml index 06f84014d..a77f9e48f 100644 --- a/doc/en/Gtk/FileChooserButton.xml +++ b/doc/en/Gtk/FileChooserButton.xml @@ -39,8 +39,9 @@ - To be added - To be added + Disposes the resources associated with this object. + + @@ -51,10 +52,10 @@ - To be added + Protected Constructor. a a - To be added + Chain to this constructor if you have manually registered a native value for your subclass. @@ -65,10 +66,10 @@ - To be added + Internal constructor a a - To be added + This is not typically used by C# code. @@ -127,9 +128,9 @@ - To be added + GType Property. a - To be added + Returns the native value for . diff --git a/doc/en/Gtk/FontButton.xml b/doc/en/Gtk/FontButton.xml index b1b6c1d5c..2e8468f4e 100644 --- a/doc/en/Gtk/FontButton.xml +++ b/doc/en/Gtk/FontButton.xml @@ -10,7 +10,8 @@ Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. A button to launch a font selection dialog. - + + Gtk.Button @@ -89,7 +90,8 @@ Public constructor. a - + + @@ -103,7 +105,8 @@ Public constructor with a font name. a , name of font to display in font selection dialog. a - + + @@ -127,9 +130,10 @@ - If this property is , the font size will be displayed along with the name of the selected font. + If this property is , the font size will be displayed along with the name of the selected font. a - + + @@ -141,10 +145,10 @@ - If this property is set to , the selected font size will be shown in the label. + If this property is set to , the selected font size will be shown in the label. a - For a more WYSIWYG way to show the selected size, see the property. + For a more WYSIWYG way to show the selected size, see the property. @@ -157,7 +161,8 @@ Retrieves the name of the currently selected font. a - + + @@ -170,7 +175,8 @@ Whether the label is drawn in the selected font. a - + + @@ -183,7 +189,8 @@ The title of the font dialog. a - + + @@ -196,7 +203,8 @@ Returns whether the name of the font style will be shown in the label. a - + + @@ -208,7 +216,8 @@ Event fired when the font is set. - + + @@ -224,9 +233,10 @@ Sets or updates the currently-displayed font in font picker dialog. a , name of font to display in font selection dialog A string containing the font name if the - font selection dialog exists, otherwise . - + font selection dialog exists, otherwise . + + - + \ No newline at end of file diff --git a/doc/en/Gtk/IMContext.xml b/doc/en/Gtk/IMContext.xml index 5da65a605..8a9c75576 100644 --- a/doc/en/Gtk/IMContext.xml +++ b/doc/en/Gtk/IMContext.xml @@ -312,7 +312,7 @@ a This function is expected to be called in response to the - event, + event, and it will likely have no effect if called at other times. @@ -333,25 +333,22 @@ a a - + Input methods typically want context in order to constrain input text based on existing text; this is important for languages such as Thai where only some sequences of characters are allowed. - - This function is implemented by emitting the event on the + + This function is implemented by emitting the event on the input method; in response to this signal, a widget should provide as much context as is available, up to an entire - paragraph, by calling . Note that there - is no obligation for a widget to respond to the signal, so + paragraph, by calling . Note that there + is no obligation for a widget to respond to the signal, so input methods must be prepared to function without context. - + @@ -481,8 +478,8 @@ a , a location to store , the retrieved string. a , location to store the retrieved attribute list. - a , the position of the cursor (in bytes) within the preedit string. - + a , the position of the cursor (in bytes) within the preedit string. + This string should be displayed inserted at the insertion point. @@ -500,4 +497,4 @@ - + \ No newline at end of file diff --git a/doc/en/Gtk/IMContextSimple.xml b/doc/en/Gtk/IMContextSimple.xml index a36d08d89..790425c08 100644 --- a/doc/en/Gtk/IMContextSimple.xml +++ b/doc/en/Gtk/IMContextSimple.xml @@ -110,14 +110,14 @@ a a - - Each row of the table consists of key symbols followed by two interpreted as the high and low words of a Unicode value. Tables are searched starting from the last added. + + Each row of the table consists of key symbols followed by two interpreted as the high and low words of a Unicode value. Tables are searched starting from the last added. - + The table must be sorted in dictionary order on the numeric value of the key symbol fields. (Values beyond the length of the sequence should be zero.) - + - + \ No newline at end of file diff --git a/doc/en/Gtk/IconView.xml b/doc/en/Gtk/IconView.xml index d73251e66..8a7ef389d 100644 --- a/doc/en/Gtk/IconView.xml +++ b/doc/en/Gtk/IconView.xml @@ -39,8 +39,9 @@ - To be added - To be added + Disposes the resources associated with this object. + + @@ -51,8 +52,8 @@ - To be added - To be added + Default handler for the event. + Override this method in a subclass to provide a default handler for the event. @@ -63,8 +64,8 @@ - To be added - To be added + Default handler for the event. + Override this method in a subclass to provide a default handler for the event. @@ -77,9 +78,9 @@ - To be added + Default handler for the event. a - To be added + Override this method in a subclass to provide a default handler for the event. @@ -90,8 +91,8 @@ - To be added - To be added + Default handler for the event. + Override this method in a subclass to provide a default handler for the event. @@ -102,8 +103,8 @@ - To be added - To be added + Default handler for the event. + Override this method in a subclass to provide a default handler for the event. @@ -117,11 +118,11 @@ - To be added + Default handler for the event. a a a - To be added + Override this method in a subclass to provide a default handler for the event. @@ -132,9 +133,9 @@ - To be added + Default handler for the event. a - To be added + Override this method in a subclass to provide a default handler for the event. @@ -145,8 +146,8 @@ - To be added - To be added + Default handler for the event. + Override this method in a subclass to provide a default handler for the event. @@ -275,10 +276,10 @@ - To be added + Protected Constructor. a a - To be added + Chain to this constructor if you have manually registered a native value for your subclass. @@ -289,10 +290,10 @@ - To be added + Internal constructor a a - To be added + This is not typically used by C# code. @@ -328,9 +329,9 @@ - To be added + GType Property. a - To be added + Returns the native value for . diff --git a/doc/en/Gtk/Item.xml b/doc/en/Gtk/Item.xml index ed4e0c58d..da38d581d 100644 --- a/doc/en/Gtk/Item.xml +++ b/doc/en/Gtk/Item.xml @@ -218,10 +218,11 @@ Deletes all widgets constructed from the specified path. - a , a factory path to prepend to . May be if starts with a factory path. + a , a factory path to prepend to . May be if starts with a factory path. a , a path - + + - + \ No newline at end of file diff --git a/doc/en/Gtk/ItemActivatedArgs.xml b/doc/en/Gtk/ItemActivatedArgs.xml index e04f0acc0..85a7ec218 100644 --- a/doc/en/Gtk/ItemActivatedArgs.xml +++ b/doc/en/Gtk/ItemActivatedArgs.xml @@ -9,8 +9,10 @@ Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. - To be added - To be added + Event data. + + The event invokes delegates which pass event data via this class. + GLib.SignalArgs @@ -24,9 +26,9 @@ - To be added - a - To be added + Public Constructor. + A new . + Create a new instance with this constructor if you need to invoke a delegate. diff --git a/doc/en/Gtk/ItemActivatedHandler.xml b/doc/en/Gtk/ItemActivatedHandler.xml index 5d3d810f8..3a371df9c 100644 --- a/doc/en/Gtk/ItemActivatedHandler.xml +++ b/doc/en/Gtk/ItemActivatedHandler.xml @@ -9,8 +9,12 @@ Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. - To be added - To be added + Event handler. + + The event utilizes this delegate: + Event data is passed via the parameter. + To attach a to an event, add the ItemActivatedHandler instance to the event. The methods referenced by the ItemActivatedHandler instance are invoked whenever the event is raised, until the ItemActivatedHandler is removed from the event. + System.Delegate diff --git a/doc/en/Gtk/MatchSelectedArgs.xml b/doc/en/Gtk/MatchSelectedArgs.xml index 06b8437a7..35b069457 100644 --- a/doc/en/Gtk/MatchSelectedArgs.xml +++ b/doc/en/Gtk/MatchSelectedArgs.xml @@ -41,7 +41,8 @@ The tree model that contains the selected match. a - + + @@ -54,8 +55,9 @@ An iterator to point at the selected match within the model. a - + + - + \ No newline at end of file diff --git a/doc/en/Gtk/MenuToolButton.xml b/doc/en/Gtk/MenuToolButton.xml index dd8172594..e6431d7ee 100644 --- a/doc/en/Gtk/MenuToolButton.xml +++ b/doc/en/Gtk/MenuToolButton.xml @@ -39,8 +39,9 @@ - To be added - To be added + Disposes the resources associated with this object. + + @@ -51,8 +52,8 @@ - To be added - To be added + Default handler for the event. + Override this method in a subclass to provide a default handler for the event. @@ -82,10 +83,10 @@ - To be added + Protected Constructor. a a - To be added + Chain to this constructor if you have manually registered a native value for your subclass. @@ -96,10 +97,10 @@ - To be added + Internal constructor a a - To be added + This is not typically used by C# code. @@ -140,9 +141,9 @@ - To be added + GType Property. a - To be added + Returns the native value for . diff --git a/doc/en/Gtk/NoExposeEventArgs.xml b/doc/en/Gtk/NoExposeEventArgs.xml index 6a90b244d..64f666d01 100644 --- a/doc/en/Gtk/NoExposeEventArgs.xml +++ b/doc/en/Gtk/NoExposeEventArgs.xml @@ -40,10 +40,11 @@ - The which triggered the . + The which triggered the . a - + + - + \ No newline at end of file diff --git a/doc/en/Gtk/Object.xml b/doc/en/Gtk/Object.xml index ca9f33bee..4f904b875 100644 --- a/doc/en/Gtk/Object.xml +++ b/doc/en/Gtk/Object.xml @@ -14,8 +14,7 @@ Base object for the Gtk object hierarchy. The difference between Gtk.Object and GLib. is a historical one, and it matters little in Gtk#. - - + GLib.Object @@ -55,11 +54,10 @@ The object is only destroyed if all the references to the object are released, t - Removes the floating reference from a , if it exists; otherwise does + Removes the floating reference from a , if it exists; otherwise does nothing. - See the overview + See the overview documentation at the top of the page. @@ -131,7 +129,8 @@ The object is only destroyed if all the references to the object are released, t as debug information. a , the internal C data underlying this object. - + + @@ -215,7 +214,8 @@ The object is only destroyed if all the references to the object are released, t a a a - + + @@ -227,7 +227,8 @@ The object is only destroyed if all the references to the object are released, t Deprecated. Do not use. - + + @@ -240,7 +241,8 @@ The object is only destroyed if all the references to the object are released, t Deprecated. Do not use. a - + + @@ -259,7 +261,8 @@ The object is only destroyed if all the references to the object are released, t a a a - + + @@ -275,7 +278,8 @@ The object is only destroyed if all the references to the object are released, t Deprecated. Do not use. a a - + + @@ -290,7 +294,8 @@ The object is only destroyed if all the references to the object are released, t Deprecated. Do not use. a - + + @@ -305,7 +310,8 @@ The object is only destroyed if all the references to the object are released, t Deprecated. Do not use. a - + + @@ -322,7 +328,8 @@ The object is only destroyed if all the references to the object are released, t Deprecated. Do not use. a a - + + @@ -337,7 +344,8 @@ The object is only destroyed if all the references to the object are released, t Deprecated. Do not use. a - + + @@ -352,7 +360,8 @@ The object is only destroyed if all the references to the object are released, t Deprecated. Do not use. a - + + @@ -367,7 +376,8 @@ The object is only destroyed if all the references to the object are released, t Deprecated. Do not use. a - + + @@ -386,7 +396,8 @@ The object is only destroyed if all the references to the object are released, t a a a - + + @@ -403,7 +414,8 @@ The object is only destroyed if all the references to the object are released, t Deprecated. Do not use. a a - + + @@ -419,7 +431,8 @@ The object is only destroyed if all the references to the object are released, t Deprecated. Do not use. a a - + + @@ -434,8 +447,9 @@ The object is only destroyed if all the references to the object are released, t Deprecated. Do not use. a - + + - + \ No newline at end of file diff --git a/doc/en/Gtk/OwnerChangeArgs.xml b/doc/en/Gtk/OwnerChangeArgs.xml index ac4eb75b3..026f9f891 100644 --- a/doc/en/Gtk/OwnerChangeArgs.xml +++ b/doc/en/Gtk/OwnerChangeArgs.xml @@ -9,8 +9,10 @@ Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. - To be added - To be added + Event data. + + The event invokes delegates which pass event data via this class. + GLib.SignalArgs @@ -24,9 +26,9 @@ - To be added - a - To be added + Public Constructor. + A new . + Create a new instance with this constructor if you need to invoke a delegate. diff --git a/doc/en/Gtk/OwnerChangeHandler.xml b/doc/en/Gtk/OwnerChangeHandler.xml index 3738fa536..9a05e01dc 100644 --- a/doc/en/Gtk/OwnerChangeHandler.xml +++ b/doc/en/Gtk/OwnerChangeHandler.xml @@ -9,8 +9,12 @@ Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. - To be added - To be added + Event handler. + + The event utilizes this delegate: + Event data is passed via the parameter. + To attach a to an event, add the OwnerChangeHandler instance to the event. The methods referenced by the OwnerChangeHandler instance are invoked whenever the event is raised, until the OwnerChangeHandler is removed from the event. + System.Delegate diff --git a/doc/en/Gtk/Paned.xml b/doc/en/Gtk/Paned.xml index b9623d4b9..638a3c8a5 100644 --- a/doc/en/Gtk/Paned.xml +++ b/doc/en/Gtk/Paned.xml @@ -144,7 +144,8 @@ public Widget GetExampleFrame() A A A - + + @@ -223,8 +224,8 @@ public Widget GetExampleFrame() - Whether the position property (related to and - ) should be used. + Whether the position property (related to and + ) should be used. an object of type an object of type @@ -458,7 +459,8 @@ public Widget GetExampleFrame() This property is derived from the size and shrinkability of the widget's children. a - + + @@ -473,7 +475,8 @@ public Widget GetExampleFrame() This property is derived from the size and shrinkability of the widget's children. a - + + @@ -493,4 +496,4 @@ public Widget GetExampleFrame() - + \ No newline at end of file diff --git a/doc/en/Gtk/Plug.xml b/doc/en/Gtk/Plug.xml index ea52af0a9..3ef6b8b13 100644 --- a/doc/en/Gtk/Plug.xml +++ b/doc/en/Gtk/Plug.xml @@ -12,13 +12,10 @@ Toplevel for embedding into other processes. - Together with , provides the ability to embed widgets from + Together with , provides the ability to embed widgets from one process into another process in a fashion that is - transparent to the user. One process creates a widget and, passes the ID of that widgets - window to the other process, which then creates a with that window ID. Any widgets + transparent to the user. One process creates a widget and, passes the ID of that widgets + window to the other process, which then creates a with that window ID. Any widgets contained in the then will appear inside the first applications window. @@ -125,7 +122,8 @@ Fired when the plug window is reparented to the socket window. - + + @@ -140,7 +138,7 @@ Finish the initialization of the plug identified by - which is currently displayed on . + which is currently displayed on . a a @@ -158,9 +156,10 @@ Public constructor. a - a , the ID of the socket to connect to on . + a , the ID of the socket to connect to on . a - + + @@ -210,8 +209,9 @@ Protected constructor. a - + + - + \ No newline at end of file diff --git a/doc/en/Gtk/PopupContextMenuArgs.xml b/doc/en/Gtk/PopupContextMenuArgs.xml index 7d9365634..f985e4798 100644 --- a/doc/en/Gtk/PopupContextMenuArgs.xml +++ b/doc/en/Gtk/PopupContextMenuArgs.xml @@ -41,7 +41,8 @@ The X location at which the context menu was popped up. a - + + @@ -54,7 +55,8 @@ The Y location at which the context menu was popped up. a - + + @@ -67,8 +69,9 @@ The mouse button number which was used to pop up the context menu. a - + + - + \ No newline at end of file diff --git a/doc/en/Gtk/PostActivateArgs.xml b/doc/en/Gtk/PostActivateArgs.xml index 0b2b3e8c0..00b72a775 100644 --- a/doc/en/Gtk/PostActivateArgs.xml +++ b/doc/en/Gtk/PostActivateArgs.xml @@ -41,8 +41,9 @@ The action that was activated. a - + + - + \ No newline at end of file diff --git a/doc/en/Gtk/PrefixInsertedArgs.xml b/doc/en/Gtk/PrefixInsertedArgs.xml index 2e5b962f6..512f40665 100644 --- a/doc/en/Gtk/PrefixInsertedArgs.xml +++ b/doc/en/Gtk/PrefixInsertedArgs.xml @@ -9,8 +9,10 @@ Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. - To be added - To be added + Event data. + + The event invokes delegates which pass event data via this class. + GLib.SignalArgs @@ -24,9 +26,9 @@ - To be added - a - To be added + Public Constructor. + A new . + Create a new instance with this constructor if you need to invoke a delegate. diff --git a/doc/en/Gtk/PrefixInsertedHandler.xml b/doc/en/Gtk/PrefixInsertedHandler.xml index c20393e6e..9458bb50a 100644 --- a/doc/en/Gtk/PrefixInsertedHandler.xml +++ b/doc/en/Gtk/PrefixInsertedHandler.xml @@ -9,8 +9,12 @@ Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. - To be added - To be added + Event handler. + + The event utilizes this delegate: + Event data is passed via the parameter. + To attach a to an event, add the PrefixInsertedHandler instance to the event. The methods referenced by the PrefixInsertedHandler instance are invoked whenever the event is raised, until the PrefixInsertedHandler is removed from the event. + System.Delegate diff --git a/doc/en/Gtk/RadioAction.xml b/doc/en/Gtk/RadioAction.xml index 9da472b93..68aff581f 100644 --- a/doc/en/Gtk/RadioAction.xml +++ b/doc/en/Gtk/RadioAction.xml @@ -177,4 +177,4 @@ - + \ No newline at end of file diff --git a/doc/en/Gtk/Range.xml b/doc/en/Gtk/Range.xml index 456e01a55..45f8e8889 100644 --- a/doc/en/Gtk/Range.xml +++ b/doc/en/Gtk/Range.xml @@ -301,11 +301,11 @@ - To be added + Default handler for the event. a a a - To be added + Override this method in a subclass to provide a default handler for the event. diff --git a/doc/en/Gtk/RetrieveSurroundingHandler.xml b/doc/en/Gtk/RetrieveSurroundingHandler.xml index 0b293e063..5afffe23f 100644 --- a/doc/en/Gtk/RetrieveSurroundingHandler.xml +++ b/doc/en/Gtk/RetrieveSurroundingHandler.xml @@ -15,7 +15,6 @@ Handlers of this class should set the input method surrounding context by calling . The method returns %TRUE if the signal was handled by the callback. - @@ -38,4 +37,4 @@ System.Void - + \ No newline at end of file diff --git a/doc/en/Gtk/Scale.xml b/doc/en/Gtk/Scale.xml index cd4cd93a9..ae3ef85ce 100644 --- a/doc/en/Gtk/Scale.xml +++ b/doc/en/Gtk/Scale.xml @@ -190,7 +190,8 @@ Gets the used to display the scale. a - + + @@ -213,10 +214,10 @@ Remember that when working with Pango you need to convert to and from pixels using PANGO_PIXELS() or . - If is , the return values are + If is , the return values are undefined. - + \ No newline at end of file diff --git a/doc/en/Gtk/Style.xml b/doc/en/Gtk/Style.xml index 2d58261b1..b15ebaffa 100644 --- a/doc/en/Gtk/Style.xml +++ b/doc/en/Gtk/Style.xml @@ -1659,4 +1659,4 @@ color or pixmap specified by this style for . - + \ No newline at end of file diff --git a/doc/en/Gtk/TextView.xml b/doc/en/Gtk/TextView.xml index af54c818e..bb9001065 100644 --- a/doc/en/Gtk/TextView.xml +++ b/doc/en/Gtk/TextView.xml @@ -1390,8 +1390,8 @@ class TextViewSample - To be added - To be added + Default handler for the event. + Override this method in a subclass to provide a default handler for the event. diff --git a/doc/en/Gtk/ToggleAction.xml b/doc/en/Gtk/ToggleAction.xml index 3cf4a1473..47a262e77 100644 --- a/doc/en/Gtk/ToggleAction.xml +++ b/doc/en/Gtk/ToggleAction.xml @@ -10,7 +10,8 @@ Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. An action which can be toggled between two states - + + Gtk.Action @@ -58,8 +59,9 @@ - Fires the event. - + Fires the event. + + @@ -85,10 +87,7 @@ Internal constructor -label displayed in menu items and on buttons a - a - This is not typically used by C# code. - +label displayed in menu items and on buttons a a This is not typically used by C# code. @@ -107,7 +106,8 @@ label displayed in menu items and on buttons a a , a tooltip for the action a , the stock icon to display in widgets representing the action a - + + @@ -135,7 +135,8 @@ label displayed in menu items and on buttons a a - + + @@ -147,8 +148,9 @@ label displayed in menu items and on buttons a Sets the checked state on the toggle action. - a , if checked - + a , if checked + + @@ -160,8 +162,9 @@ label displayed in menu items and on buttons a Event fired when the toggle is changed. - + + - + \ No newline at end of file diff --git a/doc/en/Gtk/TreeModelFilter.xml b/doc/en/Gtk/TreeModelFilter.xml index 0d74c563a..47322b5ec 100644 --- a/doc/en/Gtk/TreeModelFilter.xml +++ b/doc/en/Gtk/TreeModelFilter.xml @@ -1094,7 +1094,7 @@ in a for display. Sets the visible function used when filtering to be . a - The function should return if the given row should be visible. + The function should return if the given row should be visible. @@ -1125,4 +1125,4 @@ in a for display. - + \ No newline at end of file diff --git a/doc/en/Gtk/TreeSelection.xml b/doc/en/Gtk/TreeSelection.xml index 52be9f3fe..c566393ca 100644 --- a/doc/en/Gtk/TreeSelection.xml +++ b/doc/en/Gtk/TreeSelection.xml @@ -556,4 +556,4 @@ class TreeSelectionSample - + \ No newline at end of file diff --git a/doc/en/Gtk/Widget.xml b/doc/en/Gtk/Widget.xml index 6c498f99c..eb8a71955 100644 --- a/doc/en/Gtk/Widget.xml +++ b/doc/en/Gtk/Widget.xml @@ -1,4 +1,4 @@ - + @@ -4191,7 +4191,7 @@ Widgets are required to honor the size allocation they receive; a size request i Emits the WidgetEventAfter. - + diff --git a/doc/en/Pango/FcDecoder.xml b/doc/en/Pango/FcDecoder.xml index 835c931ab..992518ed1 100644 --- a/doc/en/Pango/FcDecoder.xml +++ b/doc/en/Pango/FcDecoder.xml @@ -33,8 +33,9 @@ - To be added - To be added + Disposes the resources associated with this object. + + @@ -63,10 +64,10 @@ - To be added + Protected Constructor. a a - To be added + Chain to this constructor if you have manually registered a native value for your subclass. @@ -77,10 +78,10 @@ - To be added + Internal constructor a a - To be added + This is not typically used by C# code. @@ -102,9 +103,9 @@ - To be added + GType Property. a - To be added + Returns the native value for . diff --git a/doc/en/Pango/Renderer.xml b/doc/en/Pango/Renderer.xml index 592f6d6f0..b27750a19 100644 --- a/doc/en/Pango/Renderer.xml +++ b/doc/en/Pango/Renderer.xml @@ -33,8 +33,9 @@ - To be added - To be added + Disposes the resources associated with this object. + + @@ -268,10 +269,10 @@ - To be added + Protected Constructor. a a - To be added + Chain to this constructor if you have manually registered a native value for your subclass. @@ -282,10 +283,10 @@ - To be added + Internal constructor a a - To be added + This is not typically used by C# code. @@ -307,9 +308,9 @@ - To be added + GType Property. a - To be added + Returns the native value for . diff --git a/doc/en/Pango/XftRenderer.xml b/doc/en/Pango/XftRenderer.xml index a49d7e2a0..649560cc0 100644 --- a/doc/en/Pango/XftRenderer.xml +++ b/doc/en/Pango/XftRenderer.xml @@ -33,8 +33,9 @@ - To be added - To be added + Disposes the resources associated with this object. + + @@ -45,10 +46,10 @@ - To be added + Protected Constructor. a a - To be added + Chain to this constructor if you have manually registered a native value for your subclass. @@ -59,10 +60,10 @@ - To be added + Internal constructor a a - To be added + This is not typically used by C# code. @@ -73,9 +74,9 @@ - To be added + GType Property. a - To be added + Returns the native value for . diff --git a/doc/gen-finalize-docs.cs b/doc/gen-finalize-docs.cs index 3a6c82874..9030198ff 100644 --- a/doc/gen-finalize-docs.cs +++ b/doc/gen-finalize-docs.cs @@ -102,107 +102,4 @@ namespace GtkSharp.Docs } } } -// gen-finalize-docs.cs - Generate documentation for Finalize method. -// -// Author: John Luke -// -// Copyright (c) 2004 Novell, Inc. -// -// This program is free software; you can redistribute it and/or -// modify it under the terms of version 2 of the GNU General Public -// License as published by the Free Software Foundation. -// -// This program is distributed in the hope that it will be useful, -// but WITHOUT ANY WARRANTY; without even the implied warranty of -// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU -// General Public License for more details. -// -// You should have received a copy of the GNU General Public -// License along with this program; if not, write to the -// Free Software Foundation, Inc., 59 Temple Place - Suite 330, -// Boston, MA 02111-1307, USA. -namespace GtkSharp.Docs -{ - using System; - using System.Collections; - using System.IO; - using System.Reflection; - using System.Xml; - using System.Xml.XPath; - - public class GenFinalizeDocs - { - public static int Main (string[] args) - { - XmlDocument api_doc = new XmlDocument (); - - foreach (string arg in args) - { - Assembly assembly; - try - { - assembly = Assembly.LoadFile (arg); - } - catch (XmlException e) - { - Console.WriteLine (e); - return 1; - } - - foreach (Type t in assembly.GetTypes ()) - { - if (!t.IsSubclassOf (typeof (GLib.Object))) - continue; - - MethodInfo mi = t.GetMethod ("Finalize", BindingFlags.NonPublic | BindingFlags.Instance); - if (mi == null) - continue; - - string filename = "en/" + t.Namespace + "/" + t.Name + ".xml"; - - try - { - Stream stream = File.OpenRead (filename); - api_doc.Load (stream); - stream.Close (); - Console.WriteLine ("opened:" + filename); - } - catch (XmlException e) - { - Console.WriteLine (e); - return 1; - } - - XPathNavigator api_nav = api_doc.CreateNavigator (); - - XPathNodeIterator iter = api_nav.Select ("/Type/Members/Member[@MemberName='Finalize']"); - if (iter.MoveNext ()) - { - XmlElement elem = ((IHasXmlNode)iter.Current).GetNode () as XmlElement; - XmlElement summ = elem ["Docs"] ["summary"]; - XmlElement rem = elem ["Docs"] ["remarks"]; - string summary = summ.InnerXml; - string remarks = rem.InnerXml; - if (summary == "To be added" && remarks == "To be added") - { - summ.InnerXml = "Disposes the resources associated with this object."; - rem.InnerXml = String.Empty; - } - else - { - Console.WriteLine ("Member had docs: Finalize"); - } - } - else - { - Console.WriteLine ("Member not found: Finalize"); - } - - api_doc.Save (filename); - } - } - return 0; - } - } -} diff --git a/doc/gen-gtype-docs.cs b/doc/gen-gtype-docs.cs index 9a9bc4232..7b13d61db 100644 --- a/doc/gen-gtype-docs.cs +++ b/doc/gen-gtype-docs.cs @@ -102,107 +102,4 @@ namespace GtkSharp.Docs } } } -// gen-gtype-docs.cs - Generate documentation for GType property. -// -// Author: John Luke -// -// Copyright (c) 2004 Novell, Inc. -// -// This program is free software; you can redistribute it and/or -// modify it under the terms of version 2 of the GNU General Public -// License as published by the Free Software Foundation. -// -// This program is distributed in the hope that it will be useful, -// but WITHOUT ANY WARRANTY; without even the implied warranty of -// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU -// General Public License for more details. -// -// You should have received a copy of the GNU General Public -// License along with this program; if not, write to the -// Free Software Foundation, Inc., 59 Temple Place - Suite 330, -// Boston, MA 02111-1307, USA. -namespace GtkSharp.Docs -{ - using System; - using System.Collections; - using System.IO; - using System.Reflection; - using System.Xml; - using System.Xml.XPath; - - public class GenGtypeDocs - { - public static int Main (string[] args) - { - XmlDocument api_doc = new XmlDocument (); - - foreach (string arg in args) - { - Assembly assembly; - try - { - assembly = Assembly.LoadFile (arg); - } - catch (XmlException e) - { - Console.WriteLine (e); - return 1; - } - - foreach (Type t in assembly.GetTypes ()) - { - if (!t.IsSubclassOf (typeof (GLib.Object))) - continue; - - PropertyInfo pi = t.GetProperty ("GType"); - if (pi == null) - continue; - - string filename = "en/" + t.Namespace + "/" + t.Name + ".xml"; - - try - { - Stream stream = File.OpenRead (filename); - api_doc.Load (stream); - stream.Close (); - Console.WriteLine ("opened:" + filename); - } - catch (XmlException e) - { - Console.WriteLine (e); - return 1; - } - - XPathNavigator api_nav = api_doc.CreateNavigator (); - - XPathNodeIterator iter = api_nav.Select ("/Type/Members/Member[@MemberName='GType']"); - if (iter.MoveNext ()) - { - XmlElement elem = ((IHasXmlNode)iter.Current).GetNode () as XmlElement; - XmlElement summ = elem ["Docs"] ["summary"]; - XmlElement rem = elem ["Docs"] ["remarks"]; - string summary = summ.InnerXml; - string remarks = rem.InnerXml; - if (summary == "To be added" && remarks == "To be added") - { - summ.InnerXml = "GType Property."; - rem.InnerXml = "Returns the native value for ."; - } - else - { - Console.WriteLine ("Member had docs: GType"); - } - } - else - { - Console.WriteLine ("Member not found: GType"); - } - - api_doc.Save (filename); - } - } - return 0; - } - } -}