Add and cleanup comments

Author: Arnaud Champion

Connect.cs

@@ -11,6 +11,9 @@
 
 namespace Libvirt
 {
+    /// <summary>
+    /// The Connect class expose all connection related methods
+    /// </summary>
     public class Connect
     {
         private const int MaxStringLength = 1024;

Domain.cs

@@ -11,6 +11,9 @@
 
 namespace Libvirt
 {
+    /// <summary>
+    /// The Domain class expose the domains related methods
+    /// </summary>
     public class Domain
     {
         /// <summary>
@@ -314,7 +317,7 @@ public class Domain
         /// Path to the interface.
         /// </param>
         /// <param name="stats">
-        /// A <see cref="virDomainInterfaceStatsStruct"/>network interface stats (returned).
+        /// A <see cref="DomainInterfaceStatsStruct"/>network interface stats (returned).
         /// </param>
         /// <param name="size">
         /// Size of stats structure.

Errors.cs

@@ -38,7 +38,7 @@ public class Errors
         /// A <see cref="IntPtr"/>pointer to the user data provided in the handler callback.
         /// </param>
         /// <param name="handler">
-        /// A <see cref="virErrorFunc"/>function to get called in case of error or NULL
+        /// A <see cref="ErrorFunc"/>function to get called in case of error or NULL
         /// </param>
         [DllImport("libvirt-0.dll", CallingConvention = CallingConvention.Cdecl, EntryPoint = "virConnSetErrorFunc")]
         public static extern void ConnSetErrorFunc(IntPtr conn, IntPtr userData, [MarshalAs(UnmanagedType.FunctionPtr)] ErrorFunc handler);
@@ -49,7 +49,7 @@ public class Errors
         /// One will need to free the result with virResetError().
         /// </summary>
         /// <param name="to">
-        /// A <see cref="virError"/> target to receive the copy.
+        /// A <see cref="Error"/> target to receive the copy.
         /// </param>
         /// <returns>
         /// 0 if no error was found and the error code otherwise and -1 in case of parameter error.
@@ -61,7 +61,7 @@ public class Errors
         /// Default routine reporting an error to stderr.
         /// </summary>
         /// <param name="err">
-        /// A <see cref="virError"/> pointer to the error.
+        /// A <see cref="Error"/> pointer to the error.
         /// </param>
         [DllImport("libvirt-0.dll", CallingConvention = CallingConvention.Cdecl, EntryPoint = "virDefaultErrorFunc")]
         public static extern void DefaultErrorFunc([In] Error err);
@@ -70,7 +70,7 @@ public class Errors
         /// Resets and frees the given error.
         /// </summary>
         /// <param name="err">
-        /// A <see cref="virError"/> error to free.
+        /// A <see cref="Error"/> error to free.
         /// </param>
         [DllImport("libvirt-0.dll", CallingConvention = CallingConvention.Cdecl, EntryPoint = "virFreeError")]
         public static extern void FreeError(Error err); // Does not work, anybody know why?
@@ -89,7 +89,7 @@ public class Errors
         /// Reset the error being pointed to.
         /// </summary>
         /// <param name="err">
-        /// A <see cref="virError"/> pointer to the to clean up.
+        /// A <see cref="Error"/> pointer to the to clean up.
         /// </param>
         [DllImport("libvirt-0.dll", CallingConvention = CallingConvention.Cdecl, EntryPoint = "virResetError")]
         public static extern void ResetError(Error err);
@@ -105,7 +105,7 @@ public class Errors
         /// Save the last error into a new error object.
         /// </summary>
         /// <returns>
-        /// A <see cref="virError"/> pointer to the copied error or NULL if allocation failed.
+        /// A <see cref="Error"/> pointer to the copied error or NULL if allocation failed.
         /// It is the caller's responsibility to free the error with virFreeError().
         /// </returns>
         [DllImport("libvirt-0.dll", CallingConvention = CallingConvention.Cdecl, EntryPoint = "virSaveLastError")]
@@ -119,7 +119,7 @@ public class Errors
         /// A <see cref="IntPtr"/>pointer to the user data provided in the handler callback.
         /// </param>
         /// <param name="handler">
-        /// A <see cref="virErrorFunc"/>function to get called in case of error or NULL.
+        /// A <see cref="ErrorFunc"/>function to get called in case of error or NULL.
         /// </param>
         [DllImport("libvirt-0.dll", CallingConvention = CallingConvention.Cdecl, EntryPoint = "virSetErrorFunc")]
         public static extern void SetErrorFunc(IntPtr userData, [MarshalAs(UnmanagedType.FunctionPtr)] ErrorFunc handler);

Event.cs

@@ -10,6 +10,9 @@
 
 namespace Libvirt
 {
+    /// <summary>
+    /// The Event class expose all the event related methods
+    /// </summary>
     public class Event
     {
         ///<summary>

Interface.cs

@@ -8,6 +8,9 @@
 
 namespace Libvirt
 {
+    /// <summary>
+    /// The Interface class expose all interface related methods
+    /// </summary>
     public class Interface
     {
         // TODO virInterfaceCreate

Library.cs

@@ -10,6 +10,9 @@
 
 namespace Libvirt
 {
+    /// <summary>
+    /// The Library class expose all libvirt library related methods
+    /// </summary>
     public class Library
     {
         /// <summary>

MarshalHelper.cs

@@ -11,8 +11,17 @@
 
 namespace Libvirt
 {
+    /// <summary>
+    /// The MarshalHelper class provide some methods that simplify marshaling
+    /// </summary>
     public class MarshalHelper
     {
+        /// <summary>
+        /// Convert an IntPtr to a string array
+        /// </summary>
+        /// <param name="stringPtr">The pointer to the first element of the array</param>
+        /// <param name="stringCount">The number of elements in the array</param>
+        /// <returns>The string array</returns>
         public static string[] ptrToStringArray(IntPtr stringPtr, int stringCount)
         {
             string[] members = new string[stringCount];
@@ -23,13 +32,22 @@ public static string[] ptrToStringArray(IntPtr stringPtr, int stringCount)
             }
             return members;
         }
-
+        /// <summary>
+        /// Convert an IntPtr to a string
+        /// </summary>
+        /// <param name="stringPtr">The pointer</param>
+        /// <returns>The string</returns>
         public static string ptrToString(IntPtr stringPtr)
         {
             IntPtr s = Marshal.ReadIntPtr(stringPtr, IntPtr.Size);
             return Marshal.PtrToStringAnsi(s);
         }
-
+        /// <summary>
+        /// Shift a pointer by offset (32 or 64 bits pointer)
+        /// </summary>
+        /// <param name="src">The pointer</param>
+        /// <param name="offset">The offset in bytes</param>
+        /// <returns>the shifted pointer</returns>
         public static IntPtr IntPtrOffset(IntPtr src, int offset)
         {
             switch (IntPtr.Size)

NativeFunctions.cs

@@ -7,16 +7,21 @@
  */
 
 using System;
-using System.Collections.Generic;
-using System.Linq;
 using System.Runtime.InteropServices;
-using System.Text;
 
 namespace Libvirt
 {
+    /// <summary>
+    /// The class expose some useful native functions
+    /// </summary>
     public class NativeFunctions
     {
         // TODO : this is a temporary workaround for virConnectOpenAuth callback, this should be removed
+        /// <summary>
+        /// duplicate a string. The strdup function shall return a pointer to a new string, which is a duplicate of the string pointed to by s1.
+        /// </summary>
+        /// <param name="strSource">Pointer to the string that should be duplicated</param>
+        /// <returns>a pointer to a new string on success. Otherwise, it shall return a null pointer</returns>
         [DllImport("msvcrt.dll", EntryPoint = "_strdup", CallingConvention = CallingConvention.Cdecl)]
         public static extern IntPtr StrDup(IntPtr strSource);
 

Network.cs

@@ -11,6 +11,9 @@
 
 namespace Libvirt
 {
+    /// <summary>
+    /// The Network clas expose all libvirt network related functions
+    /// </summary>
     public class Network
     {
         /// <summary>

Node.cs

@@ -11,6 +11,9 @@
 
 namespace Libvirt
 {
+    /// <summary>
+    /// The Node class expose all libvirt node related functions
+    /// </summary>
     public class Node
     {
 		private const int MaxStringLength = 1024;

Secret.cs

@@ -8,6 +8,9 @@
 
 namespace Libvirt
 {
+    /// <summary>
+    /// The Secret class expose all libvirt secret related functions
+    /// </summary>
     public class Secret
     {
         // TODO virSecretDefineXML

StoragePool.cs

@@ -11,6 +11,9 @@
 
 namespace Libvirt
 {
+    /// <summary>
+    /// The StoragePool class expose all libvirt storage pool related functions
+    /// </summary>
     public class StoragePool
     {
 		private const int MaxStringLength = 1024;
@@ -90,7 +93,7 @@ public class StoragePool
         /// A <see cref="IntPtr"/>pointer to storage pool.
         /// </param>
         /// <param name="flags">
-        /// A <see cref="virStoragePoolDeleteFlags"/>flags for obliteration process.
+        /// A <see cref="StoragePoolDeleteFlags"/>flags for obliteration process.
         /// </param>
         /// <returns>
         /// 0 on success, or -1 if it could not be obliterate.