Changeset 776 for trunk/sources/HeuristicLab.Core/Auxiliary.cs

Timestamp:

11/19/08 12:12:39 (16 years ago)

Author:

vdorfer

Message:

Created API documentation for HeuristicLab.Core namespace (#331)

File:

• trunk/sources/HeuristicLab.Core/Auxiliary.cs (modified) (7 diffs)

trunk/sources/HeuristicLab.Core/Auxiliary.cs

@@ -26 +26 @@
 
 namespace HeuristicLab.Core {
+  /// <summary>
+  /// Static helper class.
+  /// </summary>
   public static class Auxiliary {
     #region Cloning
+    /// <summary>
+    /// Clones the given <paramref name="obj"/> (deep clone).
+    /// </summary>
+    /// <remarks>Checks before clone if object has not already been cloned.</remarks>
+    /// <param name="obj">The object to clone.</param>
+    /// <param name="clonedObjects">A dictionary of all already cloned objects. (Needed to avoid cycles.)</param>
+    /// <returns>The cloned object.</returns>
     public static object Clone(IStorable obj, IDictionary<Guid, object> clonedObjects) {
       object clone;
@@ -38 +48 @@
 
     #region Error Messages
+    /// <summary>
+    /// Shows an error message box with a given error <paramref name="message"/> and an OK-Button.
+    /// </summary>
+    /// <param name="message">The error message to display.</param>
     public static void ShowErrorMessageBox(string message) {
       MessageBox.Show(message,
@@ -44 +58 @@
                       MessageBoxIcon.Error);
     }
+    /// <summary>
+    /// Shows an error message box with a given exception <paramref name="ex"/> and an OK-Button.
+    /// </summary>
+    /// <param name="ex">The exception to display.</param>
     public static void ShowErrorMessageBox(Exception ex) {
       MessageBox.Show(BuildErrorMessage(ex),
@@ -50 +68 @@
                       MessageBoxIcon.Error);
     }
+    /// <summary>
+    /// Builds an error message out of an exception and formats it accordingly.
+    /// </summary>
+    /// <param name="ex">The exception to format.</param>
+    /// <returns>The formated message.</returns>
     private static string BuildErrorMessage(Exception ex) {
       StringBuilder sb = new StringBuilder();
@@ -63 +86 @@
 
     #region Constraint Violation Messages
+    /// <summary>
+    /// Shows a warning message box with an OK-Button, indicating that the given constraints were violated and so 
+    /// the operation could not be completed. 
+    /// </summary>
+    /// <param name="violatedConstraints">The constraints that could not be fulfilled.</param>
     public static void ShowConstraintViolationMessageBox(ICollection<IConstraint> violatedConstraints) {
       string message = BuildConstraintViolationMessage(violatedConstraints);
@@ -70 +98 @@
                       MessageBoxIcon.Warning);
     }
+    /// <summary>
+    /// Shows a question message box with a yes-no option, where to choose whether to ignore 
+    /// the given violated constraints and to complete the operation or not.
+    /// </summary>
+    /// <param name="violatedConstraints">The constraints that could not be fulfilled.</param>
+    /// <returns>The result of the choice ("Yes" = 6, "No" = 7).</returns>
     public static DialogResult ShowIgnoreConstraintViolationMessageBox(ICollection<IConstraint> violatedConstraints) {
       string message = BuildConstraintViolationMessage(violatedConstraints);
@@ -77 +111 @@
                              MessageBoxIcon.Question);
     }
+    /// <summary>
+    /// Builds a message out of a given collection of violated constraints, 
+    /// including the constraints type and description.
+    /// </summary>
+    /// <param name="violatedConstraints">The constraints that could not be fulfilled.</param>
+    /// <returns>The message to display.</returns>
     private static string BuildConstraintViolationMessage(ICollection<IConstraint> violatedConstraints) {
       StringBuilder sb = new StringBuilder();