Changeset 3016 for trunk/sources/HeuristicLab.Persistence/3.3/Core/PersistenceException.cs

Timestamp:

03/14/10 00:42:28 (14 years ago)

Author:

epitzer

Message:

Update API docs. (#548)

File:

• trunk/sources/HeuristicLab.Persistence/3.3/Core/PersistenceException.cs (modified) (2 diffs)

trunk/sources/HeuristicLab.Persistence/3.3/Core/PersistenceException.cs

@@ -8 +8 @@
 namespace HeuristicLab.Persistence.Core {
 
+  /// <summary>
+  /// Exception thrown by components inside the persistence framework.
+  /// </summary>
   [Serializable]  
   public class PersistenceException : Exception {
+
+    /// <summary>
+    /// Initializes a new instance of the <see cref="PersistenceException"/> class.
+    /// </summary>
     public PersistenceException() : base() { }
+
+    /// <summary>
+    /// Initializes a new instance of the <see cref="PersistenceException"/> class.
+    /// </summary>
+    /// <param name="message">The message.</param>
     public PersistenceException(string message) : base(message) { }
-    public PersistenceException(string message, Exception innerException) :  base(message, innerException) { }
+
+    /// <summary>
+    /// Initializes a new instance of the <see cref="PersistenceException"/> class.
+    /// </summary>
+    /// <param name="message">The message.</param>
+    /// <param name="innerException">The inner exception.</param>
+    public PersistenceException(string message, Exception innerException) :
+      base(message, innerException) { }
+
+    /// <summary>
+    /// Initializes a new instance of the <see cref="PersistenceException"/> class.
+    /// </summary>
+    /// <param name="message">The message.</param>
+    /// <param name="innerExceptions">The inner exceptions.</param>
     public PersistenceException(string message, IEnumerable<Exception> innerExceptions)
       : base(message) {
@@ -21 +46 @@
       }
     }
+
+    /// <summary>
+    /// Returns a <see cref="System.String"/> that represents this instance.
+    /// </summary>
+    /// <returns>
+    /// A <see cref="System.String"/> that represents this instance.
+    /// </returns>
+    /// <PermissionSet>
+    ///   <IPermission class="System.Security.Permissions.FileIOPermission, mscorlib, Version=2.0.3600.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" version="1" PathDiscovery="*AllFiles*"/>
+    /// </PermissionSet>
     public override string ToString() {
       var sb = new StringBuilder()