Index: Ringtoets/Piping/src/Ringtoets.Piping.IO/SurfaceLines/CharacteristicPointsCsvReader.cs =================================================================== diff -u -r99f3b343f5ac4aed453d9f6d291217de76ef5314 -r8e182435811ddd7f9cf29ae57f62b91a2ce5a29c --- Ringtoets/Piping/src/Ringtoets.Piping.IO/SurfaceLines/CharacteristicPointsCsvReader.cs (.../CharacteristicPointsCsvReader.cs) (revision 99f3b343f5ac4aed453d9f6d291217de76ef5314) +++ Ringtoets/Piping/src/Ringtoets.Piping.IO/SurfaceLines/CharacteristicPointsCsvReader.cs (.../CharacteristicPointsCsvReader.cs) (revision 8e182435811ddd7f9cf29ae57f62b91a2ce5a29c) @@ -69,7 +69,7 @@ /// the given . /// /// The path to use for reading characteristic points. - /// is invalid. + /// Thrown when is invalid. public CharacteristicPointsCsvReader(string path) { FileUtils.ValidateFilePath(path); @@ -78,11 +78,11 @@ } /// - /// Reads the file to determine the number of available + /// Reads the file to determine the number of available /// data rows. /// /// A value greater than or equal to 0. - /// A critical error has occurred, which may be caused by: + /// Thrown when a critical error has occurred, which may be caused by: /// /// The file cannot be found at specified path. /// The specified path is invalid, such as being on an unmapped drive. @@ -106,8 +106,8 @@ /// Reads and parses the next data row to create a new instance of , /// which will contain all the declared characteristic points for some surfaceline. /// - /// Return the parsed characteristic points location, or null when at the end of the file. - /// A critical error has occurred, which may be caused by: + /// Return the parsed characteristic points location, or null when at the end of the file. + /// Thrown when a critical error has occurred, which may be caused by: /// /// The file cannot be found at specified path. /// The specified path is invalid, such as being on an unmapped drive. @@ -117,7 +117,7 @@ /// The file incompatible for importing characteristic points. /// /// - /// A parse error has occurred for the current row, which may be caused by: + /// Thrown when a parse error has occurred for the current row, which may be caused by: /// /// The row doesn't use ';' as separator character. /// The row contains a coordinate value that cannot be parsed as a double. @@ -154,7 +154,7 @@ } /// - /// Disposed the current . + /// Disposes the current . /// public void Dispose() { @@ -168,8 +168,8 @@ /// /// Reads lines from file until the first non-white line is hit. /// - /// The next line which is not a white line, or null when no non-white line could be found before the - /// end of file. + /// The next line which is not a white line, or null when no non-white + /// line could be found before the end of file. private string ReadNextNonEmptyLine() { string readText; @@ -191,7 +191,8 @@ /// Validates the header of the file. /// /// The reader, which is currently at the header row. - /// The header is not in the required format or the file is empty. + /// Thrown when the header is not in the + /// required format or the file is empty. private void ValidateHeader(TextReader reader) { var currentLine = 1; @@ -214,8 +215,8 @@ /// /// The opened text file reader. /// Row number for error messaging. - /// The read line, or null when at the end of the file. - /// An critical I/O exception occurred. + /// The read line, or null when at the end of the file. + /// Thrown when a critical I/O exception occurred. private string ReadLineAndHandleIOExceptions(TextReader reader, int currentLine) { try @@ -322,7 +323,7 @@ /// The reader at the row from which counting should start. /// The current line, used for error messaging. /// An integer greater than or equal to 0, being the number of characteristic points location rows. - /// An I/O exception occurred. + /// Thrown when an I/O exception occurred. private int CountNonEmptyLines(TextReader reader, int currentLine) { int count = 0, lineNumberForMessage = currentLine; @@ -401,7 +402,7 @@ /// The key for the type of characteristic point. /// The name of the location used for creating descriptive errors. /// A new with values for x,y,z set. - /// + /// Thrown when /// contains a value which could not be parsed to a double in the column that had to be read for creating /// the . private Point3D GetPoint3D(string[] valuesRead, string typeKey, string locationName) @@ -445,7 +446,7 @@ /// /// The tokenized string from which the name should be extracted. /// The name of the location. - /// Id value is null or empty. + /// Thrown when id value is null or empty. private string GetLocationName(IList tokenizedString) { string name = tokenizedString.Any() ? tokenizedString[columnsInFile[locationIdKey]].Trim() : null; @@ -461,7 +462,7 @@ /// /// The text. /// The tokenized parts. - /// lacks separator character. + /// Thrown when lacks separator character. private string[] TokenizeString(string readText) { if (!readText.Contains(separator))