2005-01-07 Shane Landrum <epicene@pobox.com>

* en/Glade/*: Cleaned up some parameters, added
	docs.


svn path=/trunk/gtk-sharp/; revision=38498
This commit is contained in:
Shane Landrum 2005-01-07 17:22:21 +00:00
parent ab31021a7a
commit 994538e4f9
13 changed files with 119 additions and 114 deletions

View File

@ -1,3 +1,8 @@
2005-01-07 Shane Landrum <epicene@pobox.com>
* en/Glade/*: Cleaned up some parameters, added
docs.
2005-01-07 Shane Landrum <epicene@pobox.com>
* en/Gnome/*: Cleaned up some <param> sections

View File

@ -11,7 +11,7 @@
<ThreadSafetyStatement>Gtk# is thread aware, but not thread safe; See the <link location="node:gtk-sharp/programming/threads">Gtk# Thread Programming</link> for details.</ThreadSafetyStatement>
<Docs>
<summary>The structure is used as part of the output of libglade's XML parser.</summary>
<remarks>To be added</remarks>
<remarks></remarks>
</Docs>
<Base>
<BaseTypeName>System.ValueType</BaseTypeName>
@ -56,8 +56,8 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>The key code for the accelerator.</summary>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="Modifiers">
@ -69,8 +69,8 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>The modifier keys for the accelerator.</summary>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="Signal">
@ -82,9 +82,9 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>The signal to which this accelerator should be connected.</summary>
<remarks></remarks>
</Docs>
</Member>
</Members>
</Type>
</Type>

View File

@ -8,7 +8,7 @@
<ThreadSafetyStatement>Gtk# is thread aware, but not thread safe; See the <link location="node:gtk-sharp/programming/threads">Gtk# Thread Programming</link> for details.</ThreadSafetyStatement>
<Docs>
<summary>Event handler.</summary>
<remarks>To be added</remarks>
<remarks></remarks>
</Docs>
<Base>
<BaseTypeName>System.Delegate</BaseTypeName>

View File

@ -56,8 +56,8 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>An action name.</summary>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="Description">
@ -69,9 +69,9 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>A description of the action.</summary>
<remarks></remarks>
</Docs>
</Member>
</Members>
</Type>
</Type>

View File

@ -10,8 +10,8 @@
</AssemblyInfo>
<ThreadSafetyStatement>Gtk# is thread aware, but not thread safe; See the <link location="node:gtk-sharp/programming/threads">Gtk# Thread Programming</link> for details.</ThreadSafetyStatement>
<Docs>
<summary>The structure is used as part of the output of libglade's XML parser.</summary>
<remarks />
<summary>This structure is used as part of the output of libglade's XML parser.</summary>
<remarks></remarks>
</Docs>
<Base>
<BaseTypeName>System.ValueType</BaseTypeName>
@ -57,7 +57,7 @@
</Parameters>
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="Type">
@ -70,8 +70,8 @@
</Parameters>
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<remarks></remarks>
</Docs>
</Member>
</Members>
</Type>
</Type>

View File

@ -10,8 +10,8 @@
</AssemblyInfo>
<ThreadSafetyStatement>Gtk# is thread aware, but not thread safe; See the <link location="node:gtk-sharp/programming/threads">Gtk# Thread Programming</link> for details.</ThreadSafetyStatement>
<Docs>
<summary>The structure is used as part of the output of libglade's XML parser.</summary>
<remarks />
<summary>This structure is used as part of the output of libglade's XML parser.</summary>
<remarks>Information about child widgets.</remarks>
</Docs>
<Base>
<BaseTypeName>System.ValueType</BaseTypeName>
@ -54,9 +54,9 @@
<ReturnType>Glade.WidgetInfo</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added</summary>
<returns>To be added: an object of type 'Glade.WidgetInfo'</returns>
<remarks>To be added</remarks>
<summary>A child widget.</summary>
<returns>a <see cref="T:Glade.WidgetInfo" /></returns>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="properties">
@ -66,9 +66,9 @@
<ReturnType>Glade.Property</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added</summary>
<returns>To be added: an object of type 'Glade.Property'</returns>
<remarks>To be added</remarks>
<summary>The widget's properties.</summary>
<returns>a <see cref="T:Glade.Property" /></returns>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="NProperties">
@ -80,8 +80,8 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>The number of properties this widget has.</summary>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="InternalChild">
@ -94,8 +94,8 @@
</Parameters>
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<remarks></remarks>
</Docs>
</Member>
</Members>
</Type>
</Type>

View File

@ -30,9 +30,9 @@
<ReturnType>System.Type</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added</summary>
<returns>To be added: an object of type 'Type'</returns>
<remarks>To be added</remarks>
<summary>The type of delegate that was supposed to be connected to the signal.</summary>
<returns>a <see cref="T:System.Type" /></returns>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="SignalName">
@ -42,9 +42,9 @@
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added</summary>
<returns>To be added: an object of type 'string'</returns>
<remarks>To be added</remarks>
<summary>The name of the signal that was supposed to be connected.</summary>
<returns>a <see cref="T:System.String" /></returns>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="HandlerName">
@ -54,9 +54,9 @@
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added</summary>
<returns>To be added: an object of type 'string'</returns>
<remarks>To be added</remarks>
<summary>The name of the handler that was supposed to be connected.</summary>
<returns>a <see cref="T:System.String" /></returns>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="Event">
@ -66,9 +66,9 @@
<ReturnType>System.Reflection.EventInfo</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added</summary>
<summary>Information about the event.</summary>
<returns>a <see cref="T:System.Reflection.EventInfo" /></returns>
<remarks>To be added</remarks>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
@ -82,13 +82,13 @@
<Parameter Name="delegate_type" Type="System.Type" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Public constructor.</summary>
<param name="handler_name">a <see cref="T:System.String" /></param>
<param name="signal_name">a <see cref="T:System.String" /></param>
<param name="evnt">a <see cref="T:System.Reflection.EventInfo" /></param>
<param name="delegate_type">a <see cref="T:System.Type" /></param>
<returns>a <see cref="T:Glade.HandlerNotFoundException" /></returns>
<remarks>To be added</remarks>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
@ -100,11 +100,11 @@
<Parameter Name="context" Type="System.Runtime.Serialization.StreamingContext" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Protected constructor.</summary>
<param name="info">a <see cref="T:System.Runtime.Serialization.SerializationInfo" /></param>
<param name="context">a <see cref="T:System.Runtime.Serialization.StreamingContext" /></param>
<returns>a <see cref="T:Glade.HandlerNotFoundException" /></returns>
<remarks>To be added</remarks>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
@ -119,14 +119,14 @@
<Parameter Name="inner" Type="System.Exception" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Public constructor.</summary>
<param name="handler_name">a <see cref="T:System.String" /></param>
<param name="signal_name">a <see cref="T:System.String" /></param>
<param name="evnt">a <see cref="T:System.Reflection.EventInfo" /></param>
<param name="delegate_type">a <see cref="T:System.Type" /></param>
<param name="inner">a <see cref="T:System.Exception" /></param>
<returns>a <see cref="T:Glade.HandlerNotFoundException" /></returns>
<remarks>To be added</remarks>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="GetObjectData">
@ -140,11 +140,11 @@
<Parameter Name="context" Type="System.Runtime.Serialization.StreamingContext" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Returns details about the object the handler was connected to.</summary>
<param name="info">a <see cref="T:System.Runtime.Serialization.SerializationInfo" /></param>
<param name="context">a <see cref="T:System.Runtime.Serialization.StreamingContext" /></param>
<remarks>To be added</remarks>
<remarks></remarks>
</Docs>
</Member>
</Members>
</Type>
</Type>

View File

@ -81,9 +81,9 @@
<ReturnType>Glade.WidgetInfo</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added</summary>
<summary>The top-level widgets.</summary>
<returns>an object of type <see cref="T:Glade.WidgetInfo" /></returns>
<remarks>To be added</remarks>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="Requires">
@ -96,7 +96,7 @@
</Parameters>
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="NRequires">
@ -109,7 +109,7 @@
</Parameters>
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="NToplevels">
@ -122,8 +122,8 @@
</Parameters>
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<remarks></remarks>
</Docs>
</Member>
</Members>
</Type>
</Type>

View File

@ -11,7 +11,7 @@
<ThreadSafetyStatement>Gtk# is thread aware, but not thread safe; See the <link location="node:gtk-sharp/programming/threads">Gtk# Thread Programming</link> for details.</ThreadSafetyStatement>
<Docs>
<summary>The structure is used as part of the output of libglade's XML parser.</summary>
<remarks />
<remarks>A name-value pair.</remarks>
</Docs>
<Base>
<BaseTypeName>System.ValueType</BaseTypeName>
@ -56,8 +56,8 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>The name of the property.</summary>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="Value">
@ -69,9 +69,9 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>The value of the property.</summary>
<remarks></remarks>
</Docs>
</Member>
</Members>
</Type>
</Type>

View File

@ -11,7 +11,7 @@
<ThreadSafetyStatement>Gtk# is thread aware, but not thread safe; See the <link location="node:gtk-sharp/programming/threads">Gtk# Thread Programming</link> for details.</ThreadSafetyStatement>
<Docs>
<summary>Event handler.</summary>
<remarks>To be added</remarks>
<remarks></remarks>
</Docs>
<Base>
<BaseTypeName>System.Delegate</BaseTypeName>
@ -38,7 +38,7 @@
<Docs>
<summary>To be added</summary>
<param name="result">a <see cref="T:System.IAsyncResult" /></param>
<remarks>To be added</remarks>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="BeginInvoke">
@ -70,7 +70,7 @@
<param name="callback">a <see cref="T:System.AsyncCallback" /></param>
<param name="object">a <see cref="T:System.Object" /></param>
<returns>a <see cref="T:System.IAsyncResult" /></returns>
<remarks>To be added</remarks>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
@ -86,7 +86,7 @@
<param name="object">a <see cref="T:System.Object" /></param>
<param name="method">a <see cref="T:System.IntPtr" /></param>
<returns>a <see cref="T:Glade.XML+SignalConnector+RawXMLConnectFunc" /></returns>
<remarks>To be added</remarks>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="Invoke">
@ -113,7 +113,7 @@
<param name="connect_object">a <see cref="T:System.IntPtr" /></param>
<param name="after">a <see cref="T:System.Int32" /></param>
<param name="user_data">a <see cref="T:System.IntPtr" /></param>
<remarks>To be added</remarks>
<remarks></remarks>
</Docs>
</Member>
</Members>

View File

@ -57,7 +57,7 @@
</Parameters>
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="Handler">
@ -70,7 +70,7 @@
</Parameters>
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="Object">
@ -83,7 +83,7 @@
</Parameters>
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<remarks></remarks>
</Docs>
</Member>
</Members>

View File

@ -54,9 +54,9 @@
<ReturnType>Glade.ChildInfo</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added</summary>
<returns>To be added: an object of type 'Glade.ChildInfo'</returns>
<remarks>To be added</remarks>
<summary>Details about child widgets.</summary>
<returns>a <see cref="T:Glade.ChildInfo" /></returns>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="accels">
@ -66,9 +66,9 @@
<ReturnType>Glade.AccelInfo</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added</summary>
<returns>To be added: an object of type 'Glade.AccelInfo'</returns>
<remarks>To be added</remarks>
<summary>Details about accelerators.</summary>
<returns>a <see cref="T:Glade.AccelInfo" /></returns>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="relations">
@ -78,9 +78,9 @@
<ReturnType>Glade.AtkRelationInfo</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added</summary>
<returns>To be added: an object of type 'Glade.AtkRelationInfo'</returns>
<remarks>To be added</remarks>
<summary>Details about this widget's relations.</summary>
<returns>a <see cref="T:Glade.AtkRelationInfo" /></returns>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="atk_actions">
@ -91,8 +91,8 @@
</ReturnValue>
<Docs>
<summary>To be added</summary>
<returns>To be added: an object of type 'Glade.AtkActionInfo'</returns>
<remarks>To be added</remarks>
<returns>a <see cref="T:Glade.AtkActionInfo" /></returns>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="signals">
@ -103,8 +103,8 @@
</ReturnValue>
<Docs>
<summary>To be added</summary>
<returns>To be added: an object of type 'Glade.SignalInfo'</returns>
<remarks>To be added</remarks>
<returns>a <see cref="T:Glade.SignalInfo" /></returns>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="atk_props">
@ -115,8 +115,8 @@
</ReturnValue>
<Docs>
<summary>To be added</summary>
<returns>To be added: an object of type 'Glade.Property'</returns>
<remarks>To be added</remarks>
<returns>a <see cref="T:Glade.Property" /></returns>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="properties">
@ -127,8 +127,8 @@
</ReturnValue>
<Docs>
<summary>To be added</summary>
<returns>To be added: an object of type 'Glade.Property'</returns>
<remarks>To be added</remarks>
<returns>a <see cref="T:Glade.Property" /></returns>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="parent">
@ -138,9 +138,9 @@
<ReturnType>Glade.WidgetInfo</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added</summary>
<returns>To be added: an object of type 'Glade.WidgetInfo'</returns>
<remarks>To be added</remarks>
<summary>This widget's parent widget.</summary>
<returns>a <see cref="T:Glade.WidgetInfo" /></returns>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="Classname">
@ -153,7 +153,7 @@
</Parameters>
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="Name">
@ -165,8 +165,8 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>This widget's name.</summary>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="NProperties">
@ -178,8 +178,8 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>The number of properties this widget has.</summary>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="NAtkProps">
@ -191,8 +191,8 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>The number of AtkProperties this widget has.</summary>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="NSignals">
@ -204,8 +204,8 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>The number of signals this widget connects to.</summary>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="NAtkActions">
@ -218,7 +218,7 @@
</Parameters>
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="NRelations">
@ -231,7 +231,7 @@
</Parameters>
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="NAccels">
@ -243,8 +243,8 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>The number of accelerators this widget has.</summary>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="NChildren">
@ -256,9 +256,9 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>The number of children this widget has.</summary>
<remarks></remarks>
</Docs>
</Member>
</Members>
</Type>
</Type>

View File

@ -153,7 +153,7 @@ public class GladeApp
<Docs>
<summary>To be added</summary>
<param name="type">an object of type <see cref="T:System.Type" /></param>
<remarks>To be added</remarks>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="BindFields">
@ -168,7 +168,7 @@ public class GladeApp
<Docs>
<summary>To be added</summary>
<param name="target">an object of type <see cref="T:System.Object" /></param>
<remarks>To be added</remarks>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="Autoconnect">
@ -508,11 +508,11 @@ public class GladeApp
</Parameters>
<Docs>
<summary>GParamSpec needs to be wrapped</summary>
<param name="pspec">To be added: an object of type 'IntPtr'</param>
<param name="str1ng">To be added: an object of type 'string'</param>
<param name="value">To be added: an object of type 'GLib.Value'</param>
<returns>To be added: an object of type 'bool'</returns>
<remarks>To be added</remarks>
<param name="pspec">a <see cref="T:System.IntPtr" />" /></param>
<param name="str1ng">a <see cref="T:System.String" /></param>
<param name="value">a <see cref="T:GLib.Value" /></param>
<returns>a <see cref="T:System.Boolean" /></returns>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="SignalConnectFull">