Changeset 884 for trunk/sources/HeuristicLab.Routing.TSP/TSPParser.cs

Timestamp:

12/02/08 12:41:21 (15 years ago)

Author:

vdorfer

Message:

Created API documentation for HeuristicLab.Routing.TSP namespace (#331)

File:

• trunk/sources/HeuristicLab.Routing.TSP/TSPParser.cs (modified) (3 diffs)

trunk/sources/HeuristicLab.Routing.TSP/TSPParser.cs

@@ -27 +27 @@
 
 namespace HeuristicLab.Routing.TSP {
+  /// <summary>
+  /// Parses a *.tsp file and extracts its information about a TSP.
+  /// </summary>
   public class TSPParser {
     private const int EOF = 0;
@@ -39 +42 @@
 
     private string myName;
+    /// <summary>
+    /// Gets the name of the parsed TSP.
+    /// </summary>
     public string Name {
       get { return myName; }
     }
     private double[,] myVertices;
+    /// <summary>
+    /// Gets the vertices of the parsed TSP.
+    /// </summary>
     public double[,] Vertices {
       get { return myVertices; }
     }
     private int myWeightType;
+    /// <summary>
+    /// Gets the weight type of the parsed TSP.
+    /// </summary>
     public int WeightType {
       get { return myWeightType; }
     }
 
+    /// <summary>
+    /// Initializes a new instance of <see cref="TSPParser"/> with the given <paramref name="path"/>.
+    /// </summary>
+    /// <exception cref="ArgumentException">Thrown when the input file name is not in TSP format (*.tsp)
+    /// </exception>
+    /// <param name="path">The path where the TSP is stored.</param>
     public TSPParser(String path) {
       if (!path.EndsWith(".tsp"))
@@ -61 +79 @@
     }
 
+    /// <summary>
+    /// Reads the TSP file and parses the elements.
+    /// </summary>
+    /// <exception cref="InvalidDataException">Thrown when file contains unknown (edge) types.</exception>
     public void Parse() {
       int section = -1;