Merge lp:~mandel/ubuntuone-windows-installer/fix_xml_warnings_1 into lp:ubuntuone-windows-installer/beta

[Manuel de la Peña]

First clean of the warnings given by the XmlDoc tool during compilation. This should make the docs better for community developers.

[lp:~mandel/ubuntuone-windows-installer/fix_xml_warnings_1]

29. By Manuel de la Peña on 2010-08-09

Merge with parent.

[Vincenzo Di Somma (vds)]

Thanks for the comments!

review: Approve

[Rodrigo Moya (rodrigo-moya)]

review: Approve

=== modified file 'src/Canonical.UbuntuOne.Common/Aop/DebugLogAfterCallInterceptor.cs'
--- src/Canonical.UbuntuOne.Common/Aop/DebugLogAfterCallInterceptor.cs	2010-07-26 11:09:17 +0000
+++ src/Canonical.UbuntuOne.Common/Aop/DebugLogAfterCallInterceptor.cs	2010-08-09 16:39:47 +0000
@@ -32,6 +32,13 @@
     {
         private readonly ILog _logger = LogManager.GetLogger(typeof (DebugLogAfterCallInterceptor));
 
+        /// <summary>
+        /// Callback after a given method successfully returned.
+        /// </summary>
+        /// <param name="returnValue">The value returned by the method, if any</param>
+        /// <param name="method">Method being invoked</param>
+        /// <param name="args">Arguments to the method</param>
+        /// <param name="target">Target of the method invocation. May be null.</param>
         public void AfterReturning(object returnValue, MethodInfo method, object[] args, object target)
         {
             if(Logger == null)

=== modified file 'src/Canonical.UbuntuOne.Common/Aop/DebugLogBeforeCallInterceptor.cs'
--- src/Canonical.UbuntuOne.Common/Aop/DebugLogBeforeCallInterceptor.cs	2010-07-26 11:09:17 +0000
+++ src/Canonical.UbuntuOne.Common/Aop/DebugLogBeforeCallInterceptor.cs	2010-08-09 16:39:47 +0000
@@ -48,6 +48,14 @@
 
         #endregion
 
+        /// <summary>
+        /// This is the method that will be executed by the advice before the execution of the 
+        /// actual method to with the advice was added.
+        /// </summary>
+        /// <param name="method">The MethodInfo of the method to which the advice was added.</param>
+        /// <param name="args">The arguments that have been passed to execute the method with 
+        /// the advice.</param>
+        /// <param name="target">The object that is the target of the method execution.</param>
         public void Before(MethodInfo method, object[] args, object target)
         {
             if(Logger == null)

=== modified file 'src/Canonical.UbuntuOne.Common/Aop/LoggingInterceptor.cs'
--- src/Canonical.UbuntuOne.Common/Aop/LoggingInterceptor.cs	2010-07-26 11:09:17 +0000
+++ src/Canonical.UbuntuOne.Common/Aop/LoggingInterceptor.cs	2010-08-09 16:39:47 +0000
@@ -35,6 +35,11 @@
         /// </summary>
         internal ILog Logger { get; set; }
 
+        /// <summary>
+        /// Get the logger to be used with a given object.
+        /// </summary>
+        /// <param name="caller">The caller object whose logger we want to retrieve.</param>
+        /// <returns>An ILog object that can be used to log the operations of the caller object.</returns>
         protected ILog GetLogger(Object caller)
         {
             return LogManager.GetLogger(caller.GetType());

=== modified file 'src/Canonical.UbuntuOne.Common/Container/DictionaryContainer.cs'
--- src/Canonical.UbuntuOne.Common/Container/DictionaryContainer.cs	2010-07-23 15:47:32 +0000
+++ src/Canonical.UbuntuOne.Common/Container/DictionaryContainer.cs	2010-08-09 16:39:47 +0000
@@ -23,6 +23,10 @@
 
 namespace Canonical.UbuntuOne.Common.Container
 {
+    /// <summary>
+    /// Basic container that is implemented through the use of a dictionary. This container is not
+    /// recomended for everyday use but more for testing purposes.
+    /// </summary>
     public class DictionaryContainer : IContainer
     {
         #region Private variables
@@ -55,6 +59,9 @@
             return result;
         }
 
+        /// <summary>
+        /// Cleans this instance.
+        /// </summary>
         public void Clear()
         {
             _types.Clear();

=== modified file 'src/Canonical.UbuntuOne.Common/Container/IContainer.cs'
--- src/Canonical.UbuntuOne.Common/Container/IContainer.cs	2010-07-23 15:47:32 +0000
+++ src/Canonical.UbuntuOne.Common/Container/IContainer.cs	2010-08-09 16:39:47 +0000
@@ -19,6 +19,10 @@
  */
 namespace Canonical.UbuntuOne.Common.Container
 {
+    /// <summary>
+    /// Interface to be implemented by those objects that provide the behaviour that would be 
+    /// expected by an Inversion Of Control container.
+    /// </summary>
     public interface IContainer
     {
         /// <summary>

=== modified file 'src/Canonical.UbuntuOne.Common/Container/SpringContainer.cs'
--- src/Canonical.UbuntuOne.Common/Container/SpringContainer.cs	2010-07-23 15:47:32 +0000
+++ src/Canonical.UbuntuOne.Common/Container/SpringContainer.cs	2010-08-09 16:39:47 +0000
@@ -174,6 +174,14 @@
 
         #region IDisposable Members
 
+        /// <summary>
+        /// Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
+        /// </summary>
+        /// <remarks>
+        /// Use this method to close or release unmanaged resources such as files, streams, and handles held by 
+        /// an instance of the class that implements this interface. By convention, this method is used for all 
+        /// tasks associated with freeing resources held by an object, or preparing an object for reuse.
+        /// </remarks>
         public void Dispose()
         {
             Dispose(true);
@@ -183,13 +191,17 @@
             GC.SuppressFinalize(this);
         }
 
-        // Dispose(bool disposing) executes in two distinct scenarios.
-        // If disposing equals true, the method has been called directly
-        // or indirectly by a user's code. Managed and unmanaged resources
-        // can be disposed.
-        // If disposing equals false, the method has been called by the 
-        // runtime from inside the finalizer and you should not reference 
-        // other objects. Only unmanaged resources can be disposed.
+        /// <summary>
+        /// Dispose(bool disposing) executes in two distinct scenarios.
+        /// If disposing equals true, the method has been called directly
+        /// or indirectly by a user's code. Managed and unmanaged resources
+        /// can be disposed.
+        /// If disposing equals false, the method has been called by the 
+        /// runtime from inside the finalizer and you should not reference 
+        /// other objects. Only unmanaged resources can be disposed.
+        /// </summary>
+        /// <param name="disposing">A method that is used to indicate if the 
+        /// dispose method was directly called by the user of by the system.</param>
         protected virtual void Dispose(bool disposing)
         {
             // Check to see if Dispose has already been called.
@@ -214,11 +226,13 @@
             _disposed = true;
         }
 
-        // Use C# destructor syntax for finalization code.
-        // This destructor will run only if the Dispose method 
-        // does not get called.
-        // It gives your base class the opportunity to finalize.
-        // Do not provide destructors in types derived from this class.
+        /// <summary>
+        /// Use C# destructor syntax for finalization code.
+        /// This destructor will run only if the Dispose method 
+        /// does not get called.
+        /// It gives your base class the opportunity to finalize.
+        /// Do not provide destructors in types derived from this class.
+        /// </summary>
         ~SpringContainer()
         {
             // Do not re-create Dispose clean-up code here.

=== modified file 'src/Canonical.UbuntuOne.Common/DataContracts/QueueItemData.cs'
--- src/Canonical.UbuntuOne.Common/DataContracts/QueueItemData.cs	2010-07-07 10:41:49 +0000
+++ src/Canonical.UbuntuOne.Common/DataContracts/QueueItemData.cs	2010-08-09 16:39:47 +0000
@@ -28,6 +28,10 @@
     public class QueueItemData : NodeData
     {
         //TODO: This should be an enum never a string
+        /// <summary>
+        /// Gets and sets the string that represents the operation to be performed 
+        /// on the node.
+        /// </summary>
         [DataMember]
         public string Operation { get; set; }
     }

=== modified file 'src/Canonical.UbuntuOne.Common/DataContracts/ShareData.cs'
--- src/Canonical.UbuntuOne.Common/DataContracts/ShareData.cs	2010-07-07 10:41:49 +0000
+++ src/Canonical.UbuntuOne.Common/DataContracts/ShareData.cs	2010-08-09 16:39:47 +0000
@@ -21,6 +21,9 @@
 
 namespace Canonical.UbuntuOne.Common
 {
+    /// <summary>
+    /// Data contract that describes the data of a Share in Ubuntu One.
+    /// </summary>
     [DataContract]
     public class ShareData : NodeData
     {

=== modified file 'src/Canonical.UbuntuOne.Common/DataContracts/ShareResponseData.cs'
--- src/Canonical.UbuntuOne.Common/DataContracts/ShareResponseData.cs	2010-07-07 10:41:49 +0000
+++ src/Canonical.UbuntuOne.Common/DataContracts/ShareResponseData.cs	2010-08-09 16:39:47 +0000
@@ -19,8 +19,11 @@
  */
 namespace Canonical.UbuntuOne.Common
 {
+    /// <summary>
+    /// Class that represents the data of a reponse to a sahre request.
+    /// </summary>
     public class ShareResponseData
     {
-
+        // TODO: Implement class, talk with verterok
     }
 }

=== modified file 'src/Canonical.UbuntuOne.Common/DataContracts/ThrottlingData.cs'
--- src/Canonical.UbuntuOne.Common/DataContracts/ThrottlingData.cs	2010-07-07 10:41:49 +0000
+++ src/Canonical.UbuntuOne.Common/DataContracts/ThrottlingData.cs	2010-08-09 16:39:47 +0000
@@ -21,6 +21,10 @@
 
 namespace Canonical.UbuntuOne.Common
 {
+    /// <summary>
+    /// Data contract that is used to transfer the throttling information of the
+    /// setting of the sync daemon.
+    /// </summary>
     [DataContract]
     public class ThrottlingData
     {

=== modified file 'src/Canonical.UbuntuOne.Common/IProcessManager.cs'
--- src/Canonical.UbuntuOne.Common/IProcessManager.cs	2010-07-07 10:41:49 +0000
+++ src/Canonical.UbuntuOne.Common/IProcessManager.cs	2010-08-09 16:39:47 +0000
@@ -19,6 +19,10 @@
  */
 namespace Canonical.UbuntuOne.Common
 {
+    /// <summary>
+    /// A process manager allows to perform management task on processes in the system. The manager
+    /// allows to star and stop a process as well as to query if the process is running.
+    /// </summary>
     public interface IProcessManager
     {
         /// <summary>

=== modified file 'src/Canonical.UbuntuOne.Common/OperationContracts/ISyncConfiguration.cs'
--- src/Canonical.UbuntuOne.Common/OperationContracts/ISyncConfiguration.cs	2010-08-09 16:39:46 +0000
+++ src/Canonical.UbuntuOne.Common/OperationContracts/ISyncConfiguration.cs	2010-08-09 16:39:47 +0000
@@ -21,6 +21,10 @@
 
 namespace Canonical.UbuntuOne.Common
 {
+    /// <summary>
+    /// Interface to be implemented by those object that allows to interact with the 
+    /// different setting of the sync daemon.
+    /// </summary>
     [ServiceContract(
         Name = "SyncConfiguration",
         Namespace = "http://one.ubuntu.com/syncconfiguration",

=== modified file 'src/Canonical.UbuntuOne.Common/OperationContracts/ISyncDaemon.cs'
--- src/Canonical.UbuntuOne.Common/OperationContracts/ISyncDaemon.cs	2010-08-09 16:39:46 +0000
+++ src/Canonical.UbuntuOne.Common/OperationContracts/ISyncDaemon.cs	2010-08-09 16:39:47 +0000
@@ -89,7 +89,7 @@
 
         /// <summary>
         /// Allows the client to schedule the share and node be next in the
-        // queue of waiting commands.
+        /// queue of waiting commands.
         /// </summary>
         /// <param name="shareId">The unique id that describes the share.</param>
         /// <param name="nodeId">The unique id that describes the node.</param>

=== modified file 'src/Canonical.UbuntuOne.Common/OperationContracts/ISyncDaemonClient.cs'
--- src/Canonical.UbuntuOne.Common/OperationContracts/ISyncDaemonClient.cs	2010-07-08 14:45:50 +0000
+++ src/Canonical.UbuntuOne.Common/OperationContracts/ISyncDaemonClient.cs	2010-08-09 16:39:47 +0000
@@ -21,13 +21,16 @@
 
 namespace Canonical.UbuntuOne.Common
 {
+    /// <summary>
+    /// Interface to be implementedby a sync daemon client that wants to interact with the 
+    /// daemon that manages the Ubuntu One storage in a machine.
+    /// </summary>
     [ServiceContract(Namespace = "http://one.ubuntu.com/client")]
     public interface ISyncDaemonClient
     {
         /// <summary>
         /// Callback performed when a download starts.
         /// </summary>
-        /// <param name="path">The path being downloaded.</param>
         /// <param name="data">The information of the download that is in process.</param>
         [OperationContract(IsOneWay = true)]
         void OnDownloadStarted(DownloadData data);
@@ -35,7 +38,6 @@
         /// <summary>
         /// Callback performed when a download finished. 
         /// </summary>
-        /// <param name="path">The path of the download that was finished.</param>
         /// <param name="data">The information of the download that was finished.</param>
         [OperationContract(IsOneWay = true)]
         void OnDownloadFinished(DownloadData data);
@@ -43,7 +45,6 @@
         /// <summary>
         /// Callback performed when an uploaded has been started.
         /// </summary>
-        /// <param name="path">The path of the uploading file.</param>
         /// <param name="data">The information of the upload.</param>
         [OperationContract(IsOneWay = true)]
         void OnUploadStarted(UploadData data);
@@ -51,7 +52,6 @@
         /// <summary>
         /// Calback performed when and upload has finished.
         /// </summary>
-        /// <param name="path">The path whose upload has finished.</param>
         /// <param name="data">The data of the upload.</param>
         [OperationContract(IsOneWay = true)]
         void OnUploadFinished(UploadData data);

=== modified file 'src/Canonical.UbuntuOne.Common/OperationContracts/ISyncShares.cs'
--- src/Canonical.UbuntuOne.Common/OperationContracts/ISyncShares.cs	2010-08-09 16:39:46 +0000
+++ src/Canonical.UbuntuOne.Common/OperationContracts/ISyncShares.cs	2010-08-09 16:39:47 +0000
@@ -22,6 +22,10 @@
 
 namespace Canonical.UbuntuOne.Common
 {
+    /// <summary>
+    /// Contract to be implemented by a object that allows to interact with the different shares
+    /// that a user has in the Ubuntu One storage infrastructure.
+    /// </summary>
     [ServiceContract(
         Name = "SyncShares",
         Namespace = "http://one.ubuntu.com/shares",

=== modified file 'src/Canonical.UbuntuOne.Common/ProcessManagementException.cs'
--- src/Canonical.UbuntuOne.Common/ProcessManagementException.cs	2010-07-07 10:41:49 +0000
+++ src/Canonical.UbuntuOne.Common/ProcessManagementException.cs	2010-08-09 16:39:47 +0000
@@ -28,17 +28,31 @@
     {
         #region Constructors
 
+        /// <summary>
+        /// Initializes a new instance of the ProcessManagementException class.
+        /// </summary>
         public ProcessManagementException()
         {
             
         }
 
+        /// <summary>
+        /// Initializes a new instance of the ProcessManagementException class with a specified error message.
+        /// </summary>
+        /// <param name="message">The message that describes the error. </param>
         public ProcessManagementException(string message)
             : base(message)
         {
 
         }
 
+        /// <summary>
+        /// Initializes a new instance of the ProcessManagementException class with a specified error message
+        ///  and a reference to the inner exception that is the cause of this exception.
+        /// </summary>
+        /// <param name="message">The error message that explains the reason for the exception.</param>
+        /// <param name="inner">The exception that is the cause of the current exception, 
+        /// or a null reference (Nothing in Visual Basic) if no inner exception is specified. </param>
         public ProcessManagementException(string message, Exception inner)
             : base(message, inner)
         {

=== modified file 'src/Canonical.UbuntuOne.Common/SyncDaemonException.cs'
--- src/Canonical.UbuntuOne.Common/SyncDaemonException.cs	2010-07-04 18:47:44 +0000
+++ src/Canonical.UbuntuOne.Common/SyncDaemonException.cs	2010-08-09 16:39:47 +0000
@@ -2,20 +2,37 @@
 
 namespace Canonical.UbuntuOne.Common
 {
+    /// <summary>
+    /// Exception thrown when ever there are issues with the daemon.
+    /// </summary>
     public class SyncDaemonException : Exception
     {
         #region Constructors
 
+        /// <summary>
+        /// Initializes a new instance of the SyncDaemonException class.
+        /// </summary>
         public SyncDaemonException()
         {
             
         }
 
+        /// <summary>
+        /// Initializes a new instance of the SyncDaemonException class with a specified error message.
+        /// </summary>
+        /// <param name="message">The message that describes the error. </param>
         public SyncDaemonException(string message)
             : base(message){
             
         }
 
+        /// <summary>
+        /// Initializes a new instance of the SyncDaemonException class with a specified error message
+        ///  and a reference to the inner exception that is the cause of this exception.
+        /// </summary>
+        /// <param name="message">The error message that explains the reason for the exception.</param>
+        /// <param name="inner">The exception that is the cause of the current exception, 
+        /// or a null reference (Nothing in Visual Basic) if no inner exception is specified. </param>
         public SyncDaemonException(string message, Exception inner)
             : base(message, inner)
         {

=== modified file 'src/Canonical.UbuntuOne.Common/Update/Enumerators.cs'
--- src/Canonical.UbuntuOne.Common/Update/Enumerators.cs	2010-07-14 13:50:36 +0000
+++ src/Canonical.UbuntuOne.Common/Update/Enumerators.cs	2010-08-09 16:39:47 +0000
@@ -25,7 +25,13 @@
     /// </summary>
     public enum UpdateConfirmation
     {
+        /// <summary>
+        /// Value that represents a positive answer from the user.
+        /// </summary>
         YES,
+        /// <summary>
+        /// Value that represents a newagtive answer from the user.
+        /// </summary>
         NO
     }
 }

=== modified file 'src/Canonical.UbuntuOne.Common/Update/IUpdatingPresenter.cs'
--- src/Canonical.UbuntuOne.Common/Update/IUpdatingPresenter.cs	2010-07-29 16:34:27 +0000
+++ src/Canonical.UbuntuOne.Common/Update/IUpdatingPresenter.cs	2010-08-09 16:39:47 +0000
@@ -19,6 +19,10 @@
  */
 namespace Canonical.UbuntuOne.Common.Update
 {
+    /// <summary>
+    /// Interface to be implemented by those presenters that will manage the view use to 
+    /// communicate the user that an update is taking place.
+    /// </summary>
     public interface IUpdatingPresenter
     {
         /// <summary>

=== modified file 'src/Canonical.UbuntuOne.Common/Update/IUpdatingView.cs'
--- src/Canonical.UbuntuOne.Common/Update/IUpdatingView.cs	2010-07-30 07:38:58 +0000
+++ src/Canonical.UbuntuOne.Common/Update/IUpdatingView.cs	2010-08-09 16:39:47 +0000
@@ -20,6 +20,10 @@
 
 namespace Canonical.UbuntuOne.Common.Update
 {
+    /// <summary>
+    /// Interface to be implemented by those views that will interact with the user when 
+    /// the application is being updated.
+    /// </summary>
     public interface IUpdatingView
     {
         /// <summary>

=== modified file 'src/Canonical.UbuntuOne.Common/Update/SelfUpdateException.cs'
--- src/Canonical.UbuntuOne.Common/Update/SelfUpdateException.cs	2010-07-14 13:50:36 +0000
+++ src/Canonical.UbuntuOne.Common/Update/SelfUpdateException.cs	2010-08-09 16:39:47 +0000
@@ -27,16 +27,30 @@
     /// </summary>
     public class SelfUpdateException : Exception
     {
+        /// <summary>
+        /// Initializes a new instance of the SelfUpdateException class.
+        /// </summary>
         public SelfUpdateException()
         {
         }
 
+        /// <summary>
+        /// Initializes a new instance of the SelfUpdateException class with a specified error message.
+        /// </summary>
+        /// <param name="message">The message that describes the error. </param>
         public SelfUpdateException(string message)
             : base(message)
         {
             
         }
 
+        /// <summary>
+        /// Initializes a new instance of the SelfUpdateException class with a specified error message
+        ///  and a reference to the inner exception that is the cause of this exception.
+        /// </summary>
+        /// <param name="message">The error message that explains the reason for the exception.</param>
+        /// <param name="inner">The exception that is the cause of the current exception, 
+        /// or a null reference (Nothing in Visual Basic) if no inner exception is specified. </param>
         public SelfUpdateException(string message, Exception inner)
             : base(message, inner)
         {

=== modified file 'src/Canonical.UbuntuOne.Common/Update/Updater.cs'
--- src/Canonical.UbuntuOne.Common/Update/Updater.cs	2010-07-29 17:19:47 +0000
+++ src/Canonical.UbuntuOne.Common/Update/Updater.cs	2010-08-09 16:39:47 +0000
@@ -54,9 +54,26 @@
 
         #region DI properties
 
+        /// <summary>
+        /// Gets and sets the url of the feed that is used to determine if there are updates available.
+        /// </summary>
         public string RSSFeed { get; set; }
+
+        /// <summary>
+        /// Gets and sets the message box that is used to communicate messages to the user,
+        /// </summary>
         public IMessageBox MessageBox { get; set; }
+
+        /// <summary>
+        /// Gets and sets the downloading presenter that manages the view used to tell the user
+        /// that the updates are being downloaded.
+        /// </summary>
         public IDownloadingPresenter DownloadingPresenter { get; set; }
+
+        /// <summary>
+        /// Gets and sets the updating presenter that manages the view used to tell the user 
+        /// that the updates are taking place.
+        /// </summary>
         public IUpdatingPresenter UpdatingPresenter { get; set; }
 
         #endregion
@@ -171,6 +188,10 @@
 
         #endregion
 
+        /// <summary>
+        /// Returns if the are updates present for the application.
+        /// </summary>
+        /// <returns>A flag indicating if updates are available.</returns>
         public bool UpdatesArePresent()
         {
             try
@@ -193,6 +214,10 @@
             }
         }
 
+        /// <summary>
+        /// This method will perform the update of the application using a msi installer that
+        /// is fecthed from the rss feed.
+        /// </summary>
         public void PerformUpdate()
         {
             lock (_updateLock)
@@ -243,6 +268,20 @@
             }
         }
 
+        /// <summary>
+        /// Defines a method to release allocated resources.
+        /// </summary>
+        /// <remarks>
+        /// The primary use of this interface is to release unmanaged resources. The garbage collector 
+        /// automatically releases the memory allocated to a managed object when that object is no longer 
+        /// used. However, it is not possible to predict when garbage collection will occur. Furthermore, 
+        /// the garbage collector has no knowledge of unmanaged resources such as window handles, 
+        /// or open files and streams.
+        ///
+        /// Use the Dispose method of this interface to explicitly release unmanaged resources in 
+        /// conjunction with the garbage collector. The consumer of an object can call this method 
+        /// when the object is no longer needed.
+        /// </remarks>
         public void Dispose()
         {
             if (_updater == null) return;

=== modified file 'src/Canonical.UbuntuOne.Common/Update/UpdatingPresenter.cs'
--- src/Canonical.UbuntuOne.Common/Update/UpdatingPresenter.cs	2010-07-29 16:36:02 +0000
+++ src/Canonical.UbuntuOne.Common/Update/UpdatingPresenter.cs	2010-08-09 16:39:47 +0000
@@ -20,10 +20,20 @@
 
 namespace Canonical.UbuntuOne.Common.Update
 {
+    /// <summary>
+    /// Implementation of the IUpdatingPresenter that manages the UI used to communicate the 
+    /// user that an update is taking place.
+    /// </summary>
     public class UpdatingPresenter : IUpdatingPresenter
     {
+        /// <summary>
+        /// Gets and sets the view that is used to interact with the user.
+        /// </summary>
         public IUpdatingView View { get; set; }
 
+        /// <summary>
+        /// Method used to notify the user that the updating started.
+        /// </summary>
         public void UpdatingStarted()
         {
             if(!View.IsShown)
@@ -32,6 +42,9 @@
             View.IsUpdating = true;
         }
 
+        /// <summary>
+        /// Method used to notify the user that the updating finished.
+        /// </summary>
         public void UpdatingFinished()
         {
             View.UpdatingText = UpdateResources.UpdateFinished;

=== modified file 'src/Canonical.UbuntuOne.Common/Utils/ApplicationWrapper.cs'
--- src/Canonical.UbuntuOne.Common/Utils/ApplicationWrapper.cs	2010-08-09 16:39:46 +0000
+++ src/Canonical.UbuntuOne.Common/Utils/ApplicationWrapper.cs	2010-08-09 16:39:47 +0000
@@ -21,10 +21,19 @@
 
 namespace Canonical.UbuntuOne.Common.Utils
 {
+    /// <summary>
+    /// Wrapper that allows to add an abstraction when working with the System.Window.Application class.
+    /// </summary>
     public class ApplicationWrapper : IApplication
     {
         private readonly Application _app;
 
+        /// <summary>
+        /// Initializes a new instance of the ApplicationWrapper class with a new application.
+        /// </summary>
+        /// <remarks>
+        /// At any point of time just a single ApplicationWrapper instance can be present in an application.
+        /// </remarks>
         public ApplicationWrapper()
         {
             _app = new Application();

=== modified file 'src/Canonical.UbuntuOne.Common/Utils/ExplorerException.cs'
--- src/Canonical.UbuntuOne.Common/Utils/ExplorerException.cs	2010-08-09 16:39:46 +0000
+++ src/Canonical.UbuntuOne.Common/Utils/ExplorerException.cs	2010-08-09 16:39:47 +0000
@@ -21,19 +21,37 @@
 
 namespace Canonical.UbuntuOne.Common.Utils
 {
+    /// <summary>
+    /// Exception thrown when there is a problem when interaction with the 
+    /// file explorer.
+    /// </summary>
     public class ExplorerException : Exception
     {
+        /// <summary>
+        /// Initializes a new instance of the ExplorerException class.
+        /// </summary>
         public ExplorerException()
         {
             
         }
 
+        /// <summary>
+        /// Initializes a new instance of the ExplorerException class with a specified error message.
+        /// </summary>
+        /// <param name="message">The message that describes the error. </param>
         public ExplorerException(string message)
             : base(message)
         {
             
         }
 
+        /// <summary>
+        /// Initializes a new instance of the ExplorerException class with a specified error message
+        ///  and a reference to the inner exception that is the cause of this exception.
+        /// </summary>
+        /// <param name="message">The error message that explains the reason for the exception.</param>
+        /// <param name="inner">The exception that is the cause of the current exception, 
+        /// or a null reference (Nothing in Visual Basic) if no inner exception is specified. </param>
         public ExplorerException(string message, Exception inner)
             : base(message, inner)
         {

=== modified file 'src/Canonical.UbuntuOne.Common/Utils/IExplorer.cs'
--- src/Canonical.UbuntuOne.Common/Utils/IExplorer.cs	2010-08-09 16:39:46 +0000
+++ src/Canonical.UbuntuOne.Common/Utils/IExplorer.cs	2010-08-09 16:39:47 +0000
@@ -19,6 +19,10 @@
  */
 namespace Canonical.UbuntuOne.Common.Utils
 {
+    /// <summary>
+    /// Interface to be implemented by an object that allows to interact with the 
+    /// file Explorer on Windows.
+    /// </summary>
     public interface IExplorer
     {
         /// <summary>

=== modified file 'src/Canonical.UbuntuOne.Common/Utils/IWebbrowser.cs'
--- src/Canonical.UbuntuOne.Common/Utils/IWebbrowser.cs	2010-08-09 16:39:46 +0000
+++ src/Canonical.UbuntuOne.Common/Utils/IWebbrowser.cs	2010-08-09 16:39:47 +0000
@@ -19,6 +19,10 @@
  */
 namespace Canonical.UbuntuOne.Common.Utils
 {
+    /// <summary>
+    /// Interface to be implemented by an object that allows to interact with the 
+    /// default webbrowser in the system.
+    /// </summary>
     public interface IWebbrowser
     {
         /// <summary>

=== modified file 'src/Canonical.UbuntuOne.Common/Utils/Webbrowser.cs'
--- src/Canonical.UbuntuOne.Common/Utils/Webbrowser.cs	2010-08-09 16:39:46 +0000
+++ src/Canonical.UbuntuOne.Common/Utils/Webbrowser.cs	2010-08-09 16:39:47 +0000
@@ -21,8 +21,14 @@
 
 namespace Canonical.UbuntuOne.Common.Utils
 {
+    /// <summary>
+    /// Implementation of the IWebbrowser that allows to interact with the default browser.
+    /// </summary>
     public class Webbrowser : IWebbrowser
     {
+        /// <summary>
+        /// Opens the default browser in the system and dispaly the passed url.
+        /// </summary>
         public void LauncWebpage(string url)
         {
             // trust the console to open the correct app

=== modified file 'src/Canonical.UbuntuOne.Common/Validation/EqualityValidationExtensions.cs'
--- src/Canonical.UbuntuOne.Common/Validation/EqualityValidationExtensions.cs	2010-07-23 14:59:53 +0000
+++ src/Canonical.UbuntuOne.Common/Validation/EqualityValidationExtensions.cs	2010-08-09 16:39:47 +0000
@@ -36,10 +36,10 @@
         /// A <see cref="ArgumentValidation"/> with the validations done so far.
         /// </param>
         /// <param name="value">
-        /// A <see cref="T"/> to be tested.
+        /// A comparable object to be tested.
         /// </param>
         /// <param name="otherValue">
-        /// A <see cref="T"/> with the value to test agains.
+        /// A comparable object with the value to test agains.
         /// </param>
         /// <param name="parameterName">
         /// A <see cref="System.String"/> with the message to be used in the exception.
@@ -64,10 +64,10 @@
         /// A <see cref="ArgumentValidation"/> with the validations done so far.
         /// </param>
         /// <param name="value">
-        /// A <see cref="T"/> with the argument to validate.
+        /// A comparable object with the argument to validate.
         /// </param>
         /// <param name="otherValue">
-        /// A <see cref="T"/> with the value to compare against.
+        /// A comparable object with the value to compare against.
         /// </param>
         /// <param name="parameterName">
         /// A <see cref="System.String"/> with the message to be used in the exception.
@@ -92,10 +92,10 @@
         /// A <see cref="ArgumentValidation"/> with the validations so far.
         /// </param>
         /// <param name="value">
-        /// A <see cref="T"/> to be validated.
+        /// A comparable object to be validated.
         /// </param>
         /// <param name="otherValue">
-        /// A <see cref="T"/> with the valut to validate against.
+        /// A comparable object with the value to validate against.
         /// </param>
         /// <returns>
         /// A <see cref="ArgumentValidation"/> with the result of the validation.
@@ -116,10 +116,10 @@
         /// A <see cref="ArgumentValidation"/> with the validation so far.
         /// </param>
         /// <param name="value">
-        /// A <see cref="T"/> with the argument to validate.
+        /// A comparable object with the argument to validate.
         /// </param>
         /// <param name="otherValues">
-        /// A <see cref="ICollection"/> with the values to validate against.
+        /// A collection with the values to validate against.
         /// </param>
         /// <returns>
         /// A <see cref="ArgumentValidation"/> with the result of the validation.
@@ -147,10 +147,10 @@
         /// A <see cref="ArgumentValidation"/> with the validation so far.
         /// </param>
         /// <param name="value">
-        /// A <see cref="T"/> with the argument to validate.
+        /// A comparable object with the argument to validate.
         /// </param>
         /// <param name="otherValue">
-        /// A <see cref="T"/> with the value to validate against.
+        /// A comparable object with the value to validate against.
         /// </param>
         /// <returns>
         /// A <see cref="ArgumentValidation"/> with the result of the validation.
@@ -171,10 +171,10 @@
         /// A <see cref="ArgumentValidation"/> with the valdiation result so far.
         /// </param>
         /// <param name="value">
-        /// A <see cref="T"/> with the argument to validate.
+        /// A comparable object with the argument to validate.
         /// </param>
-        /// <param name="otherValue">
-        /// A <see cref="ICollection"/> with the value to validate against.
+        /// <param name="otherValues">
+        /// A collection with the value to validate against.
         /// </param>
         /// <returns>
         /// A <see cref="ArgumentValidation"/> with the result of the validation.
@@ -219,6 +219,21 @@
                     string.Format("'{0}' must match '{1}'.", value, regularExpression)));
         }
 
+        /// <summary>
+        /// Ensures that the string that was passed as an argument is not null or empty
+        /// </summary>
+        /// <param name="argumentValidation">
+        /// A <see cref="ArgumentValidation"/> with the current result of the validations.
+        /// </param>
+        /// <param name="value">
+        /// A <see cref="System.String"/> with the argument to validate.
+        /// </param>
+        /// <param name="parameterName">
+        /// The name of the parameter under test.
+        /// </param>
+        /// <returns>
+        /// A <see cref="ArgumentValidation"/> the result of the validation.
+        /// </returns>
         public static ArgumentValidation IsNotNullOrEmpty(this ArgumentValidation argumentValidation, string  value,
             string parameterName)
         {

=== modified file 'src/Canonical.UbuntuOne.Common/Validation/ValidationExtensions.cs'
--- src/Canonical.UbuntuOne.Common/Validation/ValidationExtensions.cs	2010-07-13 08:08:53 +0000
+++ src/Canonical.UbuntuOne.Common/Validation/ValidationExtensions.cs	2010-08-09 16:39:47 +0000
@@ -22,6 +22,10 @@
 
 namespace Canonical.UbuntuOne.Common.Validation
 {
+    /// <summary>
+    /// Static class that contains a collection of extension method that can be used to 
+    /// validate the arguments of a method.
+    /// </summary>
     public static class ValidationExtensions
     {
         /// <summary>
@@ -31,7 +35,7 @@
         /// A <see cref="ArgumentValidation"/> that will be used when validating the arguments of a method.
         /// </param>
         /// <param name="theObject">
-        /// A <see cref="T"/> to test if it is null.
+        /// A ref object to test if it is null.
         /// </param>
         /// <returns>
         /// A <see cref="ArgumentValidation"/> with the result of the validation os far.
@@ -49,7 +53,7 @@
         /// A <see cref="ArgumentValidation"/> that will be used when validating the arguments of a method.
         /// </param>
         /// <param name="theObject">
-        /// A <see cref="T"/> to test if it is null.
+        /// A ref object to test if it is null.
         /// </param>
         /// <param name="parameterName">
         /// A <see cref="System.String"/> with the message to be used in the exception.