CheckButton documentation from Kevin Breit <mrproper@ximian.com>

svn path=/trunk/gtk-sharp/; revision=11782

doc/en/Gtk/CheckButton.xml

@@ -1,14 +1,18 @@
 <Type Name="CheckButton" FullName="Gtk.CheckButton">
-  <TypeSignature Language="C#" Value="public class CheckButton : Gtk.ToggleButton, Implementor, IWrapper, IWrapper, IDisposable" Maintainer="auto" />
+  <TypeSignature Language="C#" Value="public class CheckButton : Gtk.ToggleButton, Implementor, IWrapper, IWrapper, IDisposable" Maintainer="Kevin Breit" />
   <AssemblyInfo>
     <AssemblyName>gtk-sharp</AssemblyName>
     <AssemblyVersion>0.0.0.0</AssemblyVersion>
     <Attributes />
   </AssemblyInfo>
-  <ThreadSafetyStatement>To be added</ThreadSafetyStatement>
+  <ThreadSafetyStatement>CheckButton is not a thread safe object</ThreadSafetyStatement>
   <Docs>
-    <summary>To be added</summary>
+    <summary>A GtkCheckButton places a discrete GtkToggleButton next to a widget.</summary>
-    <remarks>To be added</remarks>
+    <remarks>
+      <para>
+        A GtkCheckButton places a discrete <see cref="T:Gtk.ToggleButton"/> next to a widget, usually a <see cref="T:Gtk.Label"/>. See <see cref="T:Gtk.ToggleButton"/> for more information about toggle/check buttons.
+    </para>
+  </remarks>
   </Docs>
   <Base>
     <BaseTypeName>Gtk.ToggleButton</BaseTypeName>
@@ -39,10 +43,11 @@
         <Parameter Name="label" Type="System.String" />
       </Parameters>
       <Docs>
-        <summary>To be added</summary>
+        <summary>Creates a new CheckButton object with a label to the right of it.</summary>
-        <param name="label">To be added: an object of type 'string'</param>
+        <param name="label">The label displayed to the right of the CheckButton.</param>
-        <returns>To be added: an object of type 'Gtk.CheckButton'</returns>
+        <returns>The newely created CheckButton.</returns>
-        <remarks>To be added</remarks>
+        <remarks>Creates a new CheckButton object with a label to the
+        right of it</remarks>
       </Docs>
     </Member>
     <Member MemberName="Finalize">
@@ -53,8 +58,8 @@
       </ReturnValue>
       <Parameters />
       <Docs>
-        <summary>To be added</summary>
+        <summary>Disposes of this widget</summary>
-        <remarks>To be added</remarks>
+        <remarks></remarks>
       </Docs>
     </Member>
     <Member MemberName=".ctor">
@@ -65,10 +70,10 @@
         <Parameter Name="gtype" Type="System.UInt32" />
       </Parameters>
       <Docs>
-        <summary>To be added</summary>
+        <summary>Internal contructor</summary>
-        <param name="gtype">To be added: an object of type 'uint'</param>
+        <param name="gtype"></param>
-        <returns>To be added: an object of type 'Gtk.CheckButton'</returns>
+        <returns>A new CheckButton</returns>
-        <remarks>To be added</remarks>
+        <remarks>Internal contructor</remarks>
       </Docs>
     </Member>
     <Member MemberName=".ctor">
@@ -79,10 +84,14 @@
         <Parameter Name="raw" Type="System.IntPtr" />
       </Parameters>
       <Docs>
-        <summary>To be added</summary>
+        <summary>Internal constructor</summary>
-        <param name="raw">To be added: an object of type 'IntPtr'</param>
+        <param name="raw">A pointer to a GtkCheckButton, as returned by the Gtk+ C API.</param>
-        <returns>To be added: an object of type 'Gtk.CheckButton'</returns>
+        <returns>A C# Gtk.CheckButton that wraps the <paramref name="raw"/> parameter</returns>
-        <remarks>To be added</remarks>
+        <remarks>
+          <para>
+            If you don't already know that you need this constructor, it should not be used.
+          </para>
+        </remarks>
       </Docs>
     </Member>
     <Member MemberName=".ctor">
@@ -91,9 +100,9 @@
       <ReturnValue />
       <Parameters />
       <Docs>
-        <summary>To be added</summary>
+        <summary>Constructor</summary>
-        <returns>To be added: an object of type 'Gtk.CheckButton'</returns>
+        <returns>A new CheckButton</returns>
-        <remarks>To be added</remarks>
+        <remarks></remarks>
       </Docs>
     </Member>
     <Member MemberName=".ctor">
@@ -104,10 +113,10 @@
         <Parameter Name="label" Type="System.String" />
       </Parameters>
       <Docs>
-        <summary>To be added</summary>
+        <summary>Constructor</summary>
-        <param name="label">To be added: an object of type 'string'</param>
+        <param name="label">A string for the label.</param>
-        <returns>To be added: an object of type 'Gtk.CheckButton'</returns>
+        <returns>A new CheckButton with a label</returns>
-        <remarks>To be added</remarks>
+        <remarks></remarks>
       </Docs>
     </Member>
     <Member MemberName="GType">
@@ -117,9 +126,11 @@
         <ReturnType>System.UInt32</ReturnType>
       </ReturnValue>
       <Docs>
-        <summary>To be added</summary>
+        <summary>Get the type of this object, as registered with the
-        <returns>To be added: an object of type 'uint'</returns>
+        GLib object system.</summary>
-        <remarks>To be added</remarks>
+        <returns><para>A number that uniquely identifies this type in
+        the GLib object system.</para></returns>
+        <remarks><para>Mostly for internal use.</para></remarks>
       </Docs>
     </Member>
   </Members>