optimize documentation for assembly class

1 files changed, 49 insertions, 33 deletions

diff --git a/Mono.Debugging/Mono.Debugging.Client/Assembly.cs b/Mono.Debugging/Mono.Debugging.Client/Assembly.cs
index a2b34e6..0963750 100644
--- a/Mono.Debugging/Mono.Debugging.Client/Assembly.cs
+++ b/Mono.Debugging/Mono.Debugging.Client/Assembly.cs
@@ -26,41 +26,11 @@
 using System;
 namespace Mono.Debugging.Client
 {
+	/// <summary>
+	/// Represents the assembly loaded during the debugging session.
+	/// </summary>
 	public class Assembly
 	{
-		/// <summary>
-		/// Represent the assembly loaded during the debugging session. This dataclass will be used in the modules pad view for display. 
-		/// </summary>
-		/// <param name="name"></param>
-		/// String represent the name of the assembly.
-		/// <param name="path"></param>
-		/// String represent the local path of the assembly is loaded from.
-		/// <param name="optimized"></param>
-		/// Boolean shows if the assembly has been optimized, true if the assembly is optimized.
-		/// <param name="userCode"></param>
-		/// Boolean show if the assembly is considered 'user code' by a debugger that supports 'Just My Code'.True if it's considered.
-		/// <param name="symbolStatus"></param>
-		/// String represent the Description on if symbols were found for the assembly (ex: 'Symbols Loaded', 'Symbols not found', etc.
-		/// <param name="symbolFile"></param>
-		/// String represent the Logical full path to the symbol file. The exact definition is implementation defined.
-		/// <param name="order"></param>
-		/// Integer indicating the order in which the assembly was loaded.
-		/// <param name="version"></param>
-		/// String represent the version of assembly.
-		/// <param name="timestamp"></param>
-		/// String represent the time when the assembly was built in the units of UNIX timestamp formatted as a 64-bit unsigned decimal number in a string.
-		/// <param name="address"></param>
-		/// String resent the Address where the assembly was loaded as a 64-bit unsigned decimal number.
-		/// <param name="process"></param>
-		/// String represent the process name and process ID the assembly is loaded. 
-		/// <param name="appdomain"></param>
-		/// String indicates the name of the AppDomain where the assembly is loaded.
-		/// <param name="processId"></param>
-		/// Long represent the process ID the assembly is loaded. 
-		/// <param name="hasSymbol"></param
-		/// Bool value indicate if the assembly has symbol file. Mainly use for mono project.
-		/// <param name="isDynamic"></param>
-		/// Bool value indicate if the assembly is a dynamic. Mainly use for mono project. 
 		public Assembly (string name, string path, bool optimized, bool userCode, string symbolStatus, string symbolFile, int? order, string version, string timestamp, string address, string process, string appdomain, long? processId, bool hasSymbol = false, bool isDynamic = false)
 		{
 			Name = name;
@@ -79,39 +49,85 @@ namespace Mono.Debugging.Client
 			IsDynamic = isDynamic;
 			HasSymbols = hasSymbol;
 		}
+
 		public Assembly (string path)
 		{
 			Path = path;
 		}
 
+		/// <summary>
+		/// Represents the name of the assembly.
+		/// </summary>
 		public string Name { get; private set; }
 
+		/// <summary>
+		/// Represents the local path of the assembly is loaded from.
+		/// </summary>
 		public string Path { get; private set; }
 
+		/// <summary>
+		/// Shows if the assembly has been optimized, true if the assembly is optimized.
+		/// </summary>
 		public bool Optimized { get; private set; }
 
+		/// <summary>
+		/// Shows if the assembly is considered 'user code' by a debugger that supports 'Just My Code'.True if it's considered.
+		/// </summary>
 		public bool UserCode { get; private set; }
 
+		/// <summary>
+		/// Represents the Description on if symbols were found for the assembly (ex: 'Symbols Loaded', 'Symbols not found', etc.
+		/// </summary>
 		public string SymbolStatus { get; private set; }
 
+		/// <summary>
+		/// Represents the Logical full path to the symbol file. The exact definition is implementation defined.
+		/// </summary>
 		public string SymbolFile { get; private set; }
 
+		/// <summary>
+		/// Represents the order in which the assembly was loaded.
+		/// </summary>
 		public int Order { get; private set; } = -1;
 
+		/// <summary>
+		/// Represents the version of assembly.
+		/// </summary>
 		public string Version { get; private set; }
 
+		/// <summary>
+		/// Represents the time when the assembly was built in the units of UNIX timestamp formatted as a 64-bit unsigned decimal number in a string.
+		/// </summary>
 		public string TimeStamp { get; private set; }
 
+		/// <summary>
+		/// Represents the Address where the assembly was loaded as a 64-bit unsigned decimal number.
+		/// </summary>
 		public string Address { get; private set; }
 
+		/// <summary>
+		/// Represent the process name and process ID the assembly is loaded. 
+		/// </summary>
 		public string Process { get; private set; }
 
+		/// <summary>
+		/// Represent the name of the AppDomain where the assembly is loaded.
+		/// </summary>
 		public string AppDomain { get; private set; }
 
+		/// <summary>
+		/// Represent the process ID the assembly is loaded. 
+		/// </summary>
 		public long? ProcessId { get; private set; } = -1;
 
+		/// <summary>
+		/// Indicates if the assembly has symbol file. Mainly use for mono project.
+		/// </summary>
 		public bool HasSymbols { get; private set; }
 
+		/// <summary>
+		/// Indicate if the assembly is a dynamic. Mainly use for mono project. 
+		/// </summary>
 		public bool IsDynamic { get; private set; }
 	}
 }
\ No newline at end of file