Contributions from wizito@gentelibre.org

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

AUTHORS

@@ -20,3 +20,5 @@ Documentation:
 	fsjrb@uaf.edu
 	joe@fatnsoft.com
 	pixelpapst@users.sourceforge.net
+	alexmipego@hotmail.com
+	wizito@gentelibre.org

doc/en/Gda/XmlConnection.xml

@@ -10,7 +10,11 @@
   </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>
+    <summary>
+      <para>
+Management of connections to XML data sources
+</para>
+    </summary>
     <remarks>To be added</remarks>
   </Docs>
   <Base>
@@ -36,7 +40,11 @@
         <Parameter Name="filename" Type="System.String" />
       </Parameters>
       <Docs>
-        <summary>To be added</summary>
+        <summary>
+          <para>
+Creates a Gda.XmlConnection object from the contents of filename, which must be a correct .connection file.
+</para>
+        </summary>
         <param name="filename">a <see cref="T:System.String" /></param>
         <returns>a <see cref="T:Gda.XmlConnection" /></returns>
         <remarks>To be added</remarks>
@@ -52,7 +60,11 @@
         <Parameter Name="str1ng" Type="System.String" />
       </Parameters>
       <Docs>
-        <summary>To be added</summary>
+        <summary>
+          <para>
+Creates a Gda.XmlConnection object from the given XML string.
+</para>
+        </summary>
         <param name="str1ng">a <see cref="T:System.String" /></param>
         <returns>a <see cref="T:Gda.XmlConnection" /></returns>
         <remarks>To be added</remarks>
@@ -80,7 +92,11 @@
         <Parameter Name="filename" Type="System.String" />
       </Parameters>
       <Docs>
-        <summary>To be added</summary>
+        <summary>
+          <para>
+Loads a XML file into the object.
+</para>
+        </summary>
         <param name="filename">a <see cref="T:System.String" /></param>
         <returns>a <see cref="T:System.Boolean" /></returns>
         <remarks>To be added</remarks>
@@ -96,7 +112,11 @@
         <Parameter Name="str1ng" Type="System.String" />
       </Parameters>
       <Docs>
-        <summary>To be added</summary>
+        <summary>
+          <para>
+Loads a XML string into the object.
+</para>
+        </summary>
         <param name="str1ng">a <see cref="T:System.String" /></param>
         <returns>a <see cref="T:System.Boolean" /></returns>
         <remarks>To be added</remarks>
@@ -124,7 +144,11 @@
       <Docs>
         <summary>To be added</summary>
         <returns>a <see cref="T:Gda.XmlConnection" /></returns>
-        <remarks>To be added</remarks>
+        <remarks>
+          <para>
+Creates a new GdaXmlConnection object, which lets you parse and/or create .connection files, which are XML files used to specify all parameters needed to open a database connection, and which can be used to store user's connection preferences, or for automatic connection to databases from unattended scripts and such.
+</para>
+        </remarks>
       </Docs>
     </Member>
     <Member MemberName="Password">
@@ -135,7 +159,11 @@
       </ReturnValue>
       <Parameters />
       <Docs>
-        <summary>To be added</summary>
+        <summary>
+          <para>
+Gets / Sets the password for the object.
+</para>
+        </summary>
         <returns>a <see cref="T:System.String" /></returns>
         <remarks>To be added</remarks>
       </Docs>
@@ -148,7 +176,11 @@
       </ReturnValue>
       <Parameters />
       <Docs>
-        <summary>To be added</summary>
+        <summary>
+          <para>
+Gets / Sets the user name for the object.
+</para>
+        </summary>
         <returns>a <see cref="T:System.String" /></returns>
         <remarks>To be added</remarks>
       </Docs>
@@ -161,7 +193,11 @@
       </ReturnValue>
       <Parameters />
       <Docs>
-        <summary>To be added</summary>
+        <summary>
+          <para>
+Gets / Sets the data source name for the object.
+</para>
+        </summary>
         <returns>a <see cref="T:System.String" /></returns>
         <remarks>To be added</remarks>
       </Docs>

doc/en/Gda/XmlDatabase.xml

@@ -10,8 +10,19 @@
   </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>
+    <summary>
-    <remarks>To be added</remarks>
+      <para>
+XML database representation (used for import/export and in the default provider).
+</para>
+    </summary>
+    <remarks>
+      <para>
+ The Gda.XmlDatabase class allows programs to manage databases in XML format (the format used by libgda for importing/exporting databases). It contains functions to easily manage those XML files.
+</para>
+      <para>
+With this set of functions, applications can bypass the normal libgda operation mode (via Gda.Client to access data sources), and have a direct access to the data in the XML file.
+</para>
+    </remarks>
   </Docs>
   <Base>
     <BaseTypeName>GLib.Object</BaseTypeName>
@@ -63,9 +74,13 @@
         <Parameter Name="name" Type="System.String" />
       </Parameters>
       <Docs>
-        <summary>To be added</summary>
+        <summary>
+          <para>
+Searches table and returns it.
+</para>
+        </summary>
         <param name="name">a <see cref="T:System.String" /></param>
-        <returns>a <see cref="T:Gda.Table" /></returns>
+        <returns>a <see cref="T:Gda.Table" /> or null if not found.</returns>
         <remarks>To be added</remarks>
       </Docs>
     </Member>
@@ -77,7 +92,11 @@
       </ReturnValue>
       <Parameters />
       <Docs>
-        <summary>To be added</summary>
+        <summary>
+          <para>
+Reloads the object from it's original place, discarding all changes that may have happened.
+</para>
+        </summary>
         <remarks>To be added</remarks>
       </Docs>
     </Member>
@@ -91,7 +110,11 @@
         <Parameter Name="uri" Type="System.String" />
       </Parameters>
       <Docs>
-        <summary>To be added</summary>
+        <summary>
+          <para>
+Saves the object to disk.
+</para>
+        </summary>
         <param name="uri">a <see cref="T:System.String" /></param>
         <returns>a <see cref="T:System.Boolean" /></returns>
         <remarks>To be added</remarks>
@@ -105,7 +128,11 @@
       </ReturnValue>
       <Parameters />
       <Docs>
-        <summary>To be added</summary>
+        <summary>
+          <para>
+Emits the <see cref="F:Gda.XmlDatabase.DataChanged" /> Event.
+</para>
+        </summary>
         <remarks>To be added</remarks>
       </Docs>
     </Member>
@@ -129,7 +156,11 @@
       <ReturnValue />
       <Parameters />
       <Docs>
-        <summary>To be added</summary>
+        <summary>
+          <para>
+Default Constructor.
+</para>
+        </summary>
         <returns>a <see cref="T:Gda.XmlDatabase" /></returns>
         <remarks>To be added</remarks>
       </Docs>
@@ -192,9 +223,17 @@
       </ReturnValue>
       <Parameters />
       <Docs>
-        <summary>To be added</summary>
+        <summary>
+          <para>
+Gets / Sets the uri of the object.
+</para>
+        </summary>
         <returns>a <see cref="T:System.String" /></returns>
-        <remarks>To be added</remarks>
+        <remarks>
+          <para>
+This uri will be used when saving the XML Database.
+</para>
+        </remarks>
       </Docs>
     </Member>
     <Member MemberName="UserVersion">
@@ -205,7 +244,11 @@
       </ReturnValue>
       <Parameters />
       <Docs>
-        <summary>To be added</summary>
+        <summary>
+          <para>
+Gets / Sets the user defined version of the object.
+</para>
+        </summary>
         <returns>a <see cref="T:System.String" /></returns>
         <remarks>To be added</remarks>
       </Docs>
@@ -218,9 +261,17 @@
       </ReturnValue>
       <Parameters />
       <Docs>
-        <summary>To be added</summary>
+        <summary>
+          <para>
+Gets the version of libGda used to create the object.
+</para>
+        </summary>
         <returns>a <see cref="T:System.String" /></returns>
-        <remarks>To be added</remarks>
+        <remarks>
+          <para>
+This version is the one that was used for saving the XML file last time it was saved. This value can only be "get" as it is an internal information related to the creation of the Gda.XmlDatabase object. To get the user defined database version, use the property <see cref="P:Gda.XmlDatabase.UserVersion" /> instead.
+</para>
+        </remarks>
       </Docs>
     </Member>
     <Member MemberName="Name">
@@ -231,7 +282,11 @@
       </ReturnValue>
       <Parameters />
       <Docs>
-        <summary>To be added</summary>
+        <summary>
+          <para>
+Gets / Sets the name of the object.
+</para>
+        </summary>
         <returns>a <see cref="T:System.String" /></returns>
         <remarks>To be added</remarks>
       </Docs>
@@ -244,7 +299,11 @@
       </ReturnValue>
       <Parameters />
       <Docs>
-        <summary>To be added</summary>
+        <summary>
+          <para>
+Gets a list of all table names present in the database.
+</para>
+        </summary>
         <returns>a <see cref="T:GLib.List" /></returns>
         <remarks>To be added</remarks>
       </Docs>

doc/en/Gda/XmlDocument.xml

@@ -10,7 +10,11 @@
   </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>
+    <summary>
+      <para>
+Base class for XML document management.
+</para>
+    </summary>
     <remarks>To be added</remarks>
   </Docs>
   <Base>
@@ -61,10 +65,18 @@
         <Parameter Name="uri" Type="System.String" />
       </Parameters>
       <Docs>
-        <summary>To be added</summary>
+        <summary>
+          <para>
+Saves object to disk file.
+</para>
+        </summary>
         <param name="uri">a <see cref="T:System.String" /></param>
         <returns>a <see cref="T:System.Boolean" /></returns>
-        <remarks>To be added</remarks>
+        <remarks>
+          <para>
+That is, it translates the in-memory document structure, transforms it to XML and saves, in the given file, the resulting XML output.
+</para>
+        </remarks>
       </Docs>
     </Member>
     <Member MemberName="Construct">
@@ -77,7 +89,11 @@
         <Parameter Name="root_doc" Type="System.String" />
       </Parameters>
       <Docs>
-        <summary>To be added</summary>
+        <summary>
+          <para>
+Constructs a new XmlDocument.
+</para>
+        </summary>
         <param name="root_doc">a <see cref="T:System.String" /></param>
         <remarks>To be added</remarks>
       </Docs>
@@ -104,7 +120,11 @@
         <Parameter Name="root_doc" Type="System.String" />
       </Parameters>
       <Docs>
-        <summary>To be added</summary>
+        <summary>
+          <para>
+Creates s new Gda.XmlDocument, with a root document.
+</para>
+        </summary>
         <param name="root_doc">a <see cref="T:System.String" /></param>
         <returns>a <see cref="T:Gda.XmlDocument" /></returns>
         <remarks>To be added</remarks>
@@ -118,7 +138,11 @@
       </ReturnValue>
       <Parameters />
       <Docs>
-        <summary>To be added</summary>
+        <summary>
+          <para>
+Gets / Sets the compression mode that object should use.
+</para>
+        </summary>
         <returns>a <see cref="T:System.Int32" /></returns>
         <remarks>To be added</remarks>
       </Docs>