From 0dba717c3f8a4b029344d030f8e57636fbe0a1c5 Mon Sep 17 00:00:00 2001
From: Shane Landrum <shane@mono-cvs.ximian.com>
Date: Mon, 20 Sep 2004 04:18:35 +0000
Subject: [PATCH] 2004-09-20 Shane Landrum <epicene@pobox.com>

	* en/Gdk/FilterFunc.xml
	* en/Gdk/Point.xml
	* en/Gdk/Region.xml
	* en/Gdk/Rgb.xml
	* en/Gdk/RgbCmap.xml : Added docs for Gdk classes.

svn path=/trunk/gtk-sharp/; revision=34079
---
 doc/ChangeLog             |  8 ++++
 doc/en/Gdk/FilterFunc.xml |  6 +--
 doc/en/Gdk/Point.xml      |  4 +-
 doc/en/Gdk/Region.xml     | 92 +++++++++++++++++++--------------------
 doc/en/Gdk/Rgb.xml        | 44 +++++++++++++------
 doc/en/Gdk/RgbCmap.xml    | 26 +++++------
 6 files changed, 102 insertions(+), 78 deletions(-)

diff --git a/doc/ChangeLog b/doc/ChangeLog
index d42640407..36c90e4cc 100644
--- a/doc/ChangeLog
+++ b/doc/ChangeLog
@@ -1,3 +1,11 @@
+2004-09-20 Shane Landrum <epicene@pobox.com>
+
+	* en/Gdk/FilterFunc.xml
+	* en/Gdk/Point.xml
+	* en/Gdk/Region.xml
+	* en/Gdk/Rgb.xml
+	* en/Gdk/RgbCmap.xml : Added docs for Gdk classes.
+	
 2004-09-20 Shane Landrum <epicene@pobox.com>
 	
 	* en/Gtk/FileSelection.xml
diff --git a/doc/en/Gdk/FilterFunc.xml b/doc/en/Gdk/FilterFunc.xml
index 4f8af9878..851414b7d 100644
--- a/doc/en/Gdk/FilterFunc.xml
+++ b/doc/en/Gdk/FilterFunc.xml
@@ -7,8 +7,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>To be added</summary>
-    <remarks>To be added</remarks>
+    <summary>Delegate for callbacks invoked by <see cref="M:Gdk.Window.AddFilter"/>.</summary>
+    <remarks/>
   </Docs>
   <Base>
     <BaseTypeName>System.Delegate</BaseTypeName>
@@ -30,4 +30,4 @@
   <ReturnValue>
     <ReturnType>Gdk.FilterReturn</ReturnType>
   </ReturnValue>
-</Type>
\ No newline at end of file
+</Type>
diff --git a/doc/en/Gdk/Point.xml b/doc/en/Gdk/Point.xml
index 6d4e654c9..ae8555368 100644
--- a/doc/en/Gdk/Point.xml
+++ b/doc/en/Gdk/Point.xml
@@ -42,7 +42,7 @@
       </Parameters>
       <Docs>
         <summary>Internal constructor</summary>
-        <param name="raw">To be added: an object of type 'IntPtr'</param>
+        <param name="raw">a <see cref="M:IntPtr"/>, pointer to internal data</param>
         <returns />
         <remarks>This is an internal constructor, and should not be used by user code.</remarks>
       </Docs>
@@ -104,4 +104,4 @@
       </Docs>
     </Member>
   </Members>
-</Type>
\ No newline at end of file
+</Type>
diff --git a/doc/en/Gdk/Region.xml b/doc/en/Gdk/Region.xml
index 8a90921c6..b1667c5fe 100644
--- a/doc/en/Gdk/Region.xml
+++ b/doc/en/Gdk/Region.xml
@@ -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>To be added</summary>
-    <remarks>To be added</remarks>
+    <summary>Represents an area of the screen.</summary>
+    <remarks/>
   </Docs>
   <Base>
     <BaseTypeName>System.ValueType</BaseTypeName>
@@ -30,9 +30,9 @@
       </Parameters>
       <Docs>
         <summary>To be added</summary>
-        <param name="rectangle">To be added: an object of type 'Gdk.Rectangle'</param>
-        <returns>To be added: an object of type 'Gdk.Region'</returns>
-        <remarks>To be added</remarks>
+        <param name="rectangle">a <see cref="M:Gdk.Rectangle"/></param>
+        <returns>a <see cref="M:Gdk.Region"/></returns>
+        <remarks/>
       </Docs>
     </Member>
     <Member MemberName="Copy">
@@ -44,8 +44,8 @@
       <Parameters />
       <Docs>
         <summary>To be added</summary>
-        <returns>To be added: an object of type 'Gdk.Region'</returns>
-        <remarks>To be added</remarks>
+        <returns>a <see cref="M:Gdk.Region"/></returns>
+        <remarks/>
       </Docs>
     </Member>
     <Member MemberName="RectIn">
@@ -59,9 +59,9 @@
       </Parameters>
       <Docs>
         <summary>To be added</summary>
-        <param name="rect">To be added: an object of type 'Gdk.Rectangle'</param>
-        <returns>To be added: an object of type 'Gdk.OverlapType'</returns>
-        <remarks>To be added</remarks>
+        <param name="rect">a <see cref="M:Gdk.Rectangle"/></param>
+        <returns>a <see cref="M:Gdk.OverlapType"/></returns>
+        <remarks/>
       </Docs>
     </Member>
     <Member MemberName="SpansIntersectForeach">
@@ -78,11 +78,11 @@
       </Parameters>
       <Docs>
         <summary>To be added</summary>
-        <param name="spans">To be added: an object of type 'Gdk.Span'</param>
-        <param name="n_spans">To be added: an object of type 'int'</param>
-        <param name="sorted">To be added: an object of type 'bool'</param>
-        <param name="function">To be added: an object of type 'Gdk.SpanFunc'</param>
-        <remarks>To be added</remarks>
+        <param name="spans">a <see cref="M:Gdk.Span"/></param>
+        <param name="n_spans">a <see cref="M:System.Int32"/></param>
+        <param name="sorted">a <see cref="M:System.Boolean"/></param>
+        <param name="function">a <see cref="M:Gdk.SpanFunc"/></param>
+        <remarks/>
       </Docs>
     </Member>
     <Member MemberName="Xor">
@@ -96,8 +96,8 @@
       </Parameters>
       <Docs>
         <summary>To be added</summary>
-        <param name="source2">To be added: an object of type 'Gdk.Region'</param>
-        <remarks>To be added</remarks>
+        <param name="source2">a <see cref="M:Gdk.Region"/></param>
+        <remarks/>
       </Docs>
     </Member>
     <Member MemberName="Subtract">
@@ -111,8 +111,8 @@
       </Parameters>
       <Docs>
         <summary>To be added</summary>
-        <param name="source2">To be added: an object of type 'Gdk.Region'</param>
-        <remarks>To be added</remarks>
+        <param name="source2">a <see cref="M:Gdk.Region"/></param>
+        <remarks/>
       </Docs>
     </Member>
     <Member MemberName="UnionWithRect">
@@ -126,8 +126,8 @@
       </Parameters>
       <Docs>
         <summary>To be added</summary>
-        <param name="rect">To be added: an object of type 'Gdk.Rectangle'</param>
-        <remarks>To be added</remarks>
+        <param name="rect">a <see cref="M:Gdk.Rectangle"/></param>
+        <remarks/>
       </Docs>
     </Member>
     <Member MemberName="Destroy">
@@ -139,7 +139,7 @@
       <Parameters />
       <Docs>
         <summary>To be added</summary>
-        <remarks>To be added</remarks>
+        <remarks/>
       </Docs>
     </Member>
     <Member MemberName="Offset">
@@ -154,9 +154,9 @@
       </Parameters>
       <Docs>
         <summary>To be added</summary>
-        <param name="dx">To be added: an object of type 'int'</param>
-        <param name="dy">To be added: an object of type 'int'</param>
-        <remarks>To be added</remarks>
+        <param name="dx">a <see cref="M:System.Int32"/></param>
+        <param name="dy">a <see cref="M:System.Int32"/></param>
+        <remarks/>
       </Docs>
     </Member>
     <Member MemberName="Empty">
@@ -168,8 +168,8 @@
       <Parameters />
       <Docs>
         <summary>To be added</summary>
-        <returns>To be added: an object of type 'bool'</returns>
-        <remarks>To be added</remarks>
+        <returns>a <see cref="M:System.Boolean"/></returns>
+        <remarks/>
       </Docs>
     </Member>
     <Member MemberName="Intersect">
@@ -183,8 +183,8 @@
       </Parameters>
       <Docs>
         <summary>To be added</summary>
-        <param name="source2">To be added: an object of type 'Gdk.Region'</param>
-        <remarks>To be added</remarks>
+        <param name="source2">a <see cref="M:Gdk.Region"/></param>
+        <remarks/>
       </Docs>
     </Member>
     <Member MemberName="PointIn">
@@ -199,10 +199,10 @@
       </Parameters>
       <Docs>
         <summary>To be added</summary>
-        <param name="x">To be added: an object of type 'int'</param>
-        <param name="y">To be added: an object of type 'int'</param>
-        <returns>To be added: an object of type 'bool'</returns>
-        <remarks>To be added</remarks>
+        <param name="x">a <see cref="M:System.Int32"/></param>
+        <param name="y">a <see cref="M:System.Int32"/></param>
+        <returns>a <see cref="M:System.Boolean"/></returns>
+        <remarks/>
       </Docs>
     </Member>
     <Member MemberName="Union">
@@ -216,8 +216,8 @@
       </Parameters>
       <Docs>
         <summary>To be added</summary>
-        <param name="source2">To be added: an object of type 'Gdk.Region'</param>
-        <remarks>To be added</remarks>
+        <param name="source2">a <see cref="M:Gdk.Region"/></param>
+        <remarks/>
       </Docs>
     </Member>
     <Member MemberName="Equal">
@@ -231,9 +231,9 @@
       </Parameters>
       <Docs>
         <summary>To be added</summary>
-        <param name="region2">To be added: an object of type 'Gdk.Region'</param>
-        <returns>To be added: an object of type 'bool'</returns>
-        <remarks>To be added</remarks>
+        <param name="region2">a <see cref="M:Gdk.Region"/></param>
+        <returns>a <see cref="M:System.Boolean"/></returns>
+        <remarks/>
       </Docs>
     </Member>
     <Member MemberName="Shrink">
@@ -248,9 +248,9 @@
       </Parameters>
       <Docs>
         <summary>To be added</summary>
-        <param name="dx">To be added: an object of type 'int'</param>
-        <param name="dy">To be added: an object of type 'int'</param>
-        <remarks>To be added</remarks>
+        <param name="dx">a <see cref="M:System.Int32"/></param>
+        <param name="dy">a <see cref="M:System.Int32"/></param>
+        <remarks/>
       </Docs>
     </Member>
     <Member MemberName=".ctor">
@@ -264,7 +264,7 @@
         <summary>To be added</summary>
         <param name="raw">a <see cref="T:System.IntPtr" /></param>
         <returns>a <see cref="T:Gdk.Region" /></returns>
-        <remarks>To be added</remarks>
+        <remarks/>
       </Docs>
     </Member>
     <Member MemberName=".ctor">
@@ -275,7 +275,7 @@
       <Docs>
         <summary>To be added</summary>
         <returns>a <see cref="T:Gdk.Region" /></returns>
-        <remarks>To be added</remarks>
+        <remarks/>
       </Docs>
     </Member>
     <Member MemberName="GetRectangles">
@@ -288,7 +288,7 @@
       <Docs>
         <summary>To be added</summary>
         <returns>a <see cref="T:Gdk.Rectangle[]" /></returns>
-        <remarks>To be added</remarks>
+        <remarks/>
       </Docs>
     </Member>
     <Member MemberName="Clipbox">
@@ -301,7 +301,7 @@
       <Docs>
         <summary>To be added</summary>
         <returns>a <see cref="T:Gdk.Rectangle" /></returns>
-        <remarks>To be added</remarks>
+        <remarks/>
       </Docs>
     </Member>
     <Member MemberName="Polygon">
@@ -319,7 +319,7 @@
         <param name="points">a <see cref="T:Gdk.Point" /></param>
         <param name="fill_rule">a <see cref="T:System.Int32" /></param>
         <returns>a <see cref="T:Gdk.Region" /></returns>
-        <remarks>To be added</remarks>
+        <remarks/>
       </Docs>
     </Member>
   </Members>
diff --git a/doc/en/Gdk/Rgb.xml b/doc/en/Gdk/Rgb.xml
index 20214dade..a87b01dad 100644
--- a/doc/en/Gdk/Rgb.xml
+++ b/doc/en/Gdk/Rgb.xml
@@ -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>To be added</summary>
-    <remarks>To be added</remarks>
+    <remarks/>
   </Docs>
   <Base>
     <BaseTypeName>System.Object</BaseTypeName>
@@ -30,10 +30,26 @@
         <Parameter Name="color" Type="Gdk.Color" />
       </Parameters>
       <Docs>
-        <summary>To be added</summary>
+        <summary>
+	  <p><paramref name="colormap"/> should be the colormap for the graphics context and
+	    drawable you're using to draw. If you're drawing to a <see cref="T:Gtk.Widget"/>,
+	    call <see cref="M:Gtk.Widget.GetColormap"/>.
+	  </p><p>
+	    <paramref name="color"/> should have its red, green, and blue fields initialized;
+	    this method will fill in <paramref name="color"/>'s pixel field with the best
+	    matching pixel from a color cube. The color is then ready to be
+	    used for drawing, e.g. you can call <see cref="M:Gdk.GC.SetForeground"/> which
+	    expects "pixel" to be initialized.
+	  </p><p>
+	    In many cases, you can avoid this whole issue by setting
+	    <see cref="P:Gdk.GC.RgbFgColor"/> or <see cref="P:Gdk.GC.RgbBgColor"/>, which
+	    do not expect "pixel" to be initialized in advance. If you use those
+	    mutators, there's no need for calling this method.
+	  </p>
+	</summary>
         <param name="colormap">a <see cref="T:Gdk.Colormap" /></param>
         <param name="color">a <see cref="T:Gdk.Color" /></param>
-        <remarks>To be added</remarks>
+        <remarks/>
       </Docs>
     </Member>
     <Member MemberName="Ditherable">
@@ -46,7 +62,7 @@
       <Docs>
         <summary>To be added</summary>
         <returns>a <see cref="T:System.Boolean" /></returns>
-        <remarks>To be added</remarks>
+        <remarks/>
       </Docs>
     </Member>
     <Member MemberName=".ctor">
@@ -55,9 +71,9 @@
       <ReturnValue />
       <Parameters />
       <Docs>
-        <summary>To be added</summary>
+        <summary>Basic constructor.</summary>
         <returns>a <see cref="T:Gdk.Rgb" /></returns>
-        <remarks>To be added</remarks>
+        <remarks/>
       </Docs>
     </Member>
     <Member MemberName="MinColors">
@@ -69,10 +85,10 @@
       <Parameters>
       </Parameters>
       <Docs>
-        <summary>To be added</summary>
+        <summary>The minimum number of colors for this colormap.</summary>
         <param name="value">a <see cref="T:System.Int32" /></param>
         <returns>a <see cref="T:System.Int32" /></returns>
-        <remarks>To be added</remarks>
+        <remarks/>
       </Docs>
     </Member>
     <Member MemberName="Visual">
@@ -84,7 +100,7 @@
       <Docs>
         <summary>To be added</summary>
         <returns>a <see cref="T:Gdk.Visual" /></returns>
-        <remarks>To be added</remarks>
+        <remarks/>
       </Docs>
     </Member>
     <Member MemberName="Install">
@@ -99,7 +115,7 @@
         <summary>To be added</summary>
         <param name="value">a <see cref="T:System.Boolean" /></param>
         <returns>a <see cref="T:System.Boolean" /></returns>
-        <remarks>To be added</remarks>
+        <remarks/>
       </Docs>
     </Member>
     <Member MemberName="Colormap">
@@ -111,7 +127,7 @@
       <Docs>
         <summary>To be added</summary>
         <returns>a <see cref="T:Gdk.Colormap" /></returns>
-        <remarks>To be added</remarks>
+        <remarks/>
       </Docs>
     </Member>
     <Member MemberName="Verbose">
@@ -123,11 +139,11 @@
       <Parameters>
       </Parameters>
       <Docs>
-        <summary>To be added</summary>
+        <summary>Whether or not to be verbose to the console about actions. Useful for debugging.</summary>
         <param name="value">a <see cref="T:System.Boolean" /></param>
         <returns>a <see cref="T:System.Boolean" /></returns>
-        <remarks>To be added</remarks>
+        <remarks/>
       </Docs>
     </Member>
   </Members>
-</Type>
\ No newline at end of file
+</Type>
diff --git a/doc/en/Gdk/RgbCmap.xml b/doc/en/Gdk/RgbCmap.xml
index deef154c0..00a7932ff 100644
--- a/doc/en/Gdk/RgbCmap.xml
+++ b/doc/en/Gdk/RgbCmap.xml
@@ -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>To be added</summary>
-    <remarks>To be added</remarks>
+    <remarks/>
   </Docs>
   <Base>
     <BaseTypeName>System.ValueType</BaseTypeName>
@@ -27,8 +27,8 @@
       </ReturnValue>
       <Parameters />
       <Docs>
-        <summary>To be added</summary>
-        <remarks>To be added</remarks>
+        <summary>Returns an empty <see cref="T:Gdk.RgbCmap"/></summary>
+        <remarks/>
       </Docs>
     </Member>
     <Member MemberName="New">
@@ -41,10 +41,10 @@
         <Parameter Name="raw" Type="System.IntPtr" />
       </Parameters>
       <Docs>
-        <summary>To be added</summary>
-        <param name="raw">To be added: an object of type 'IntPtr'</param>
-        <returns>To be added: an object of type 'Gdk.RgbCmap'</returns>
-        <remarks>To be added</remarks>
+        <summary>Constructor.</summary>
+        <param name="raw">a <see cref="M:IntPtr"/></param>
+        <returns>a <see cref="M:Gdk.RgbCmap"/></returns>
+        <remarks/>
       </Docs>
     </Member>
     <Member MemberName="Free">
@@ -55,8 +55,8 @@
       </ReturnValue>
       <Parameters />
       <Docs>
-        <summary>To be added</summary>
-        <remarks>To be added</remarks>
+        <summary>Do not use. For internal use only.</summary>
+        <remarks/>
       </Docs>
     </Member>
     <Member MemberName="New">
@@ -74,7 +74,7 @@
         <param name="colors">a <see cref="T:System.UInt32&amp;" /></param>
         <param name="n_colors">a <see cref="T:System.Int32" /></param>
         <returns>a <see cref="T:Gdk.RgbCmap" /></returns>
-        <remarks>To be added</remarks>
+        <remarks/>
       </Docs>
     </Member>
     <Member MemberName="Colors">
@@ -87,7 +87,7 @@
       </Parameters>
       <Docs>
         <summary>To be added</summary>
-        <remarks>To be added</remarks>
+        <remarks/>
       </Docs>
     </Member>
     <Member MemberName="NColors">
@@ -100,8 +100,8 @@
       </Parameters>
       <Docs>
         <summary>To be added</summary>
-        <remarks>To be added</remarks>
+        <remarks/>
       </Docs>
     </Member>
   </Members>
-</Type>
\ No newline at end of file
+</Type>