From ddc14873b221a08ea91c7f6807d707a460ce6b28 Mon Sep 17 00:00:00 2001
From: Jaime Anguiano Olarra <jaime@mono-cvs.ximian.com>
Date: Wed, 14 May 2003 19:22:02 +0000
Subject: [PATCH] Added some descriptions and info for all the constructors.

svn path=/trunk/gtk-sharp/; revision=14586
---
 doc/en/Gtk/Image.xml | 157 ++++++++++++++++++++++++++++---------------
 1 file changed, 101 insertions(+), 56 deletions(-)

diff --git a/doc/en/Gtk/Image.xml b/doc/en/Gtk/Image.xml
index d47f56b1b..8d639334b 100644
--- a/doc/en/Gtk/Image.xml
+++ b/doc/en/Gtk/Image.xml
@@ -1,5 +1,7 @@
 <Type Name="Image" FullName="Gtk.Image">
-  <TypeSignature Language="C#" Value="public class Image : Gtk.Misc, Implementor, IWrapper, IWrapper, IDisposable" Maintainer="auto" />
+  <TypeSignature Language="C#" Value="public class Image : Gtk.Misc,
+  Implementor, IWrapper, IWrapper, IDisposable" Maintainer="Jaime
+  Anguiano Olarra" />
   <AssemblyInfo>
     <AssemblyName>gtk-sharp</AssemblyName>
     <AssemblyVersion>0.0.0.0</AssemblyVersion>
@@ -7,8 +9,12 @@
   </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>This <see cref="T:Gtk.Widget" /> is used to display an
+  image. It can be used as a container for a <see cref="Gdk.Pixbuf" />
+  or a <see cref="Gdk.PixbufAnimation" /> to get custom interfaces.
+  <see cref="Gtk.Image" /> cannot launch events, it's neccessary to
+  include it inside a <see cref="Gtk.EventBox" /> for that purpose.</summary>
+    <remarks />
   </Docs>
   <Base>
     <BaseTypeName>Gtk.Misc</BaseTypeName>
@@ -131,9 +137,9 @@
       <ReturnValue />
       <Parameters />
       <Docs>
-        <summary>To be added</summary>
-        <returns>To be added: an object of type 'Gtk.Image'</returns>
-        <remarks>To be added</remarks>
+        <summary>Default parameterless constructor.</summary>
+        <returns>An instance of type <see cref="T:Gtk.Image" /></returns>
+        <remarks />
       </Docs>
     </Member>
     <Member MemberName=".ctor">
@@ -144,10 +150,13 @@
         <Parameter Name="animation" Type="Gdk.PixbufAnimation" />
       </Parameters>
       <Docs>
-        <summary>To be added</summary>
-        <param name="animation">To be added: an object of type 'Gdk.PixbufAnimation'</param>
-        <returns>To be added: an object of type 'Gtk.Image'</returns>
-        <remarks>To be added</remarks>
+        <summary>This constructor is used to create an instance of <see
+  cref="Gtk.Image" /> containing the <see cref="T:Gdk.PixbufAnimation"
+  /> passed to it.</summary>
+        <param name="animation"><see cref="T:Gdk.PixbufAnimation" />
+  to be displayed by the Image.</param>
+        <returns>An instance of type <see cref="T:Gtk.Image" />.</returns>
+        <remarks/>
       </Docs>
     </Member>
     <Member MemberName=".ctor">
@@ -158,10 +167,13 @@
         <Parameter Name="filename" Type="System.String" />
       </Parameters>
       <Docs>
-        <summary>To be added</summary>
-        <param name="filename">To be added: an object of type 'string'</param>
-        <returns>To be added: an object of type 'Gtk.Image'</returns>
-        <remarks>To be added</remarks>
+        <summary>This constructor is used to create an instance of
+  <see cref="T:Gtk.Image" /> containing the image stored in the
+  filename whose path is given by the 'filename' parameter.</summary>
+        <param name="filename"><see langword="string" /> representing
+  the path to the image file.</param>
+        <returns>An instance of type <see cref="T:Gtk.Image" />.</returns>
+        <remarks />
       </Docs>
     </Member>
     <Member MemberName=".ctor">
@@ -173,11 +185,15 @@
         <Parameter Name="size" Type="Gtk.IconSize" />
       </Parameters>
       <Docs>
-        <summary>To be added</summary>
-        <param name="icon_set">To be added: an object of type 'Gtk.IconSet'</param>
-        <param name="size">To be added: an object of type 'Gtk.IconSize'</param>
-        <returns>To be added: an object of type 'Gtk.Image'</returns>
-        <remarks>To be added</remarks>
+        <summary>This constructor is used to create an instance of
+  <see cref="T:Gtk.Image" /> containing the <see cref="T:Gtk.IconSet"
+  /> and using the <see cref="T:Gtk.IconSize" /> passed to it.</summary>
+        <param name="icon_set"><see cref="T:Gtk.IconSet" /> to be
+  displayed by the Image.</param>
+        <param name="size"><see cref="T:Gtk.IconSize" /> to be used by
+  the Image.</param>
+        <returns>An instance of type <see cref="T:Gtk.Image" />.</returns>
+        <remarks />
       </Docs>
     </Member>
     <Member MemberName=".ctor">
@@ -189,11 +205,14 @@
         <Parameter Name="mask" Type="Gdk.Bitmap" />
       </Parameters>
       <Docs>
-        <summary>To be added</summary>
-        <param name="image">To be added: an object of type 'Gdk.Image'</param>
-        <param name="mask">To be added: an object of type 'Gdk.Bitmap'</param>
-        <returns>To be added: an object of type 'Gtk.Image'</returns>
-        <remarks>To be added</remarks>
+        <summary>This constructor is used to create an instance of
+  <see cref="T:Gtk.Image" /> containing the <see cref="T:Gdk.Image" />
+  and the <see cref="T:Gdk.Bitmap" /> passed to it.</summary>
+        <param name="image"><see cref="T:Gdk.Image" /> to be displayed
+  by the Image.</param>
+        <param name="mask"><see cref="T:Gdk.Bitmap" /> mask to be used.</param>
+        <returns>An instance of type <see cref="T:Gtk.Image" />.</returns>
+        <remarks />
       </Docs>
     </Member>
     <Member MemberName=".ctor">
@@ -204,10 +223,13 @@
         <Parameter Name="pixbuf" Type="Gdk.Pixbuf" />
       </Parameters>
       <Docs>
-        <summary>To be added</summary>
-        <param name="pixbuf">To be added: an object of type 'Gdk.Pixbuf'</param>
-        <returns>To be added: an object of type 'Gtk.Image'</returns>
-        <remarks>To be added</remarks>
+        <summary>This constructor is used to create an instance of
+  <see cref="T:Gtk.Image" /> containing the <see cref="T:Gdk.Pixbuf" />
+  passed to it.</summary>
+        <param name="pixbuf"><see cref="T:Gdk.Pixbuf" /> to be
+  displayed by the Image.</param>
+        <returns>To be added: an object of type 'Gtk.Image'An instance of type <see cref="T:Gtk.Image" />.</returns>
+        <remarks />
       </Docs>
     </Member>
     <Member MemberName=".ctor">
@@ -219,11 +241,15 @@
         <Parameter Name="mask" Type="Gdk.Bitmap" />
       </Parameters>
       <Docs>
-        <summary>To be added</summary>
-        <param name="pixmap">To be added: an object of type 'Gdk.Pixmap'</param>
-        <param name="mask">To be added: an object of type 'Gdk.Bitmap'</param>
-        <returns>To be added: an object of type 'Gtk.Image'</returns>
-        <remarks>To be added</remarks>
+        <summary>This constructor is used to create an instance of
+  <see cref="T:Gtk.Image" /> containing the <see cref="T:Gdk.Pixmap"
+  /> and the <see cref="Gtk.Bitmap" /> mask passed to it.</summary>
+        <param name="pixmap"><see cref="T:Gdk.Pixmap" /> displayed by
+  the Image.</param>
+        <param name="mask"><see cref="T:Gdk.Bitmap" /> mask used by
+  the Image.</param>
+        <returns>An instance of type <see cref="T:Gtk.Image" />.</returns>
+        <remarks />
       </Docs>
     </Member>
     <Member MemberName=".ctor">
@@ -235,11 +261,15 @@
         <Parameter Name="size" Type="Gtk.IconSize" />
       </Parameters>
       <Docs>
-        <summary>To be added</summary>
-        <param name="stock_id">To be added: an object of type 'string'</param>
-        <param name="size">To be added: an object of type 'Gtk.IconSize'</param>
-        <returns>To be added: an object of type 'Gtk.Image'</returns>
-        <remarks>To be added</remarks>
+        <summary>This constructor is used to create an instance of
+  <see cref="T:Gtk.Image" /> containing the <see cref="Gtk.Stock" />
+  represented by the <see langword="string" /> passed to it and with the
+  size represented by the <see cref="Gtk.IconSize" /> passed.</summary>
+        <param name="stock_id"><see langword="string" /> identifier
+  for the <see cref="Gtk.Stock" />.</param>
+        <param name="size"><see cref="Gtk.IconSize" /> used by the Image.</param>
+        <returns>An instance of type <see cref="T:Gtk.Image" />.</returns>
+        <remarks />
       </Docs>
     </Member>
     <Member MemberName="GType">
@@ -340,10 +370,12 @@
         <Parameter Name="value" Type="Gdk.Pixbuf" />
       </Parameters>
       <Docs>
-        <summary>To be added</summary>
-        <param name="value">To be added: an object of type 'Gdk.Pixbuf'</param>
-        <returns>To be added: an object of type 'Gdk.Pixbuf'</returns>
-        <remarks>To be added</remarks>
+        <summary>Gets or sets the <see cref="T:Gdk.Pixbuf" />
+  associated to the Image.</summary>
+        <param name="value"><see cref="T:Gdk.Pixbuf" /> that will be
+  set to the Image.</param>
+        <returns><see cref="T:Gtk.Pixbuf" /> that the Image contains.</returns>
+        <remarks />
       </Docs>
     </Member>
     <Member MemberName="IconSize">
@@ -400,10 +432,12 @@
         <Parameter Name="value" Type="Gtk.IconSet" />
       </Parameters>
       <Docs>
-        <summary>To be added</summary>
-        <param name="value">To be added: an object of type 'Gtk.IconSet'</param>
-        <returns>To be added: an object of type 'Gtk.IconSet'</returns>
-        <remarks>To be added</remarks>
+        <summary>Gets or sets the <see cref="T:Gtk.Iconset" />
+  associated to the Image.</summary>
+        <param name="value"><see cref="T:Gtk.Iconset" /> that will be
+  set to the Image.</param>
+        <returns><see cref="T:Gtk.Iconset" /> that the Image contains.</returns>
+        <remarks />
       </Docs>
     </Member>
     <Member MemberName="PixbufAnimation">
@@ -416,10 +450,12 @@
         <Parameter Name="value" Type="Gdk.PixbufAnimation" />
       </Parameters>
       <Docs>
-        <summary>To be added</summary>
-        <param name="value">To be added: an object of type 'Gdk.PixbufAnimation'</param>
-        <returns>To be added: an object of type 'Gdk.PixbufAnimation'</returns>
-        <remarks>To be added</remarks>
+        <summary>Gets or sets the <see cref="T:Gdk.PixbufAnimation" />
+  associated to the Image.</summary>
+        <param name="value"><see cref="T:Gdk.PixbufAnimation" /> that will be
+  set to the Image.</param>
+        <returns><see cref="T:Gtk.PixbufAnimation" /> that the Image contains.</returns>
+        <remarks />
       </Docs>
     </Member>
     <Member MemberName="Mask">
@@ -448,11 +484,13 @@
         <Parameter Name="value" Type="Gdk.Pixmap" />
       </Parameters>
       <Docs>
-        <summary>To be added</summary>
-        <param name="value">To be added: an object of type 'Gdk.Pixmap'</param>
-        <returns>To be added: an object of type 'Gdk.Pixmap'</returns>
-        <remarks>To be added</remarks>
-      </Docs>
+        <summary>Gets or sets the <see cref="T:Gdk.Pixmap" />
+  associated to the Image.</summary>
+        <param name="value"><see cref="T:Gdk.Pixmap" /> that will be
+  set to the Image.</param>
+        <returns><see cref="T:Gtk.Pixmap" /> that the Image contains.</returns>
+        <remarks />
+	</Docs>
     </Member>
     <Member MemberName="ImageProp">
       <MemberSignature Language="C#" Value="public Gdk.Image ImageProp { set; get; };" />
@@ -464,7 +502,14 @@
         <Parameter Name="value" Type="Gdk.Image" />
       </Parameters>
       <Docs>
-        <summary>To be added</summary>
+        <summary>Gets or sets the <see cref="T:Gdk.Image" />
+  associated to the Image.</summary>
+        <param name="value"><see cref="T:Gdk.Image" /> that will be
+  set to the Image.</param>
+        <returns><see cref="T:Gdk.Image" /> that the Image contains.</returns>
+        <remarks />
+
+              <summary>To be added</summary>
         <param name="value">To be added: an object of type 'Gdk.Image'</param>
         <returns>To be added: an object of type 'Gdk.Image'</returns>
         <remarks>To be added</remarks>