Index: Application/Ringtoets/src/Application.Ringtoets.Storage/Exceptions/CannotDeleteBackupFileException.cs
===================================================================
diff -u -r05013c44d1273bac219a442dc7959706c6bac715 -r8e182435811ddd7f9cf29ae57f62b91a2ce5a29c
--- Application/Ringtoets/src/Application.Ringtoets.Storage/Exceptions/CannotDeleteBackupFileException.cs (.../CannotDeleteBackupFileException.cs) (revision 05013c44d1273bac219a442dc7959706c6bac715)
+++ Application/Ringtoets/src/Application.Ringtoets.Storage/Exceptions/CannotDeleteBackupFileException.cs (.../CannotDeleteBackupFileException.cs) (revision 8e182435811ddd7f9cf29ae57f62b91a2ce5a29c)
@@ -48,7 +48,7 @@
///
/// The error message that explains the reason for the exception.
/// The exception that is the cause of the current exception,
- /// or a null reference if no inner exception is specified.
+ /// or a null reference if no inner exception is specified.
public CannotDeleteBackupFileException(string message, Exception inner) : base(message, inner) {}
}
}
\ No newline at end of file
Index: Ringtoets/ClosingStructures/src/Ringtoets.ClosingStructures.Service/ClosingStructuresCalculationService.cs
===================================================================
diff -u -r6279011a954055d718ba3acf1144fc0da8923bf7 -r8e182435811ddd7f9cf29ae57f62b91a2ce5a29c
--- Ringtoets/ClosingStructures/src/Ringtoets.ClosingStructures.Service/ClosingStructuresCalculationService.cs (.../ClosingStructuresCalculationService.cs) (revision 6279011a954055d718ba3acf1144fc0da8923bf7)
+++ Ringtoets/ClosingStructures/src/Ringtoets.ClosingStructures.Service/ClosingStructuresCalculationService.cs (.../ClosingStructuresCalculationService.cs) (revision 8e182435811ddd7f9cf29ae57f62b91a2ce5a29c)
@@ -160,7 +160,7 @@
///
/// The for which to validate the values.
/// The for which to validate the values.
- /// truec> if has no validation errors; falsec> otherwise.
+ /// true if has no validation errors; false otherwise.
public static bool Validate(StructuresCalculation calculation, IAssessmentSection assessmentSection)
{
CalculationServiceHelper.LogValidationBeginTime(calculation.Name);
Index: Ringtoets/Common/src/Ringtoets.Common.Service/DesignWaterLevelCalculationService.cs
===================================================================
diff -u -rbd73023d5f8926a411da214fb5ce522056a0e30a -r8e182435811ddd7f9cf29ae57f62b91a2ce5a29c
--- Ringtoets/Common/src/Ringtoets.Common.Service/DesignWaterLevelCalculationService.cs (.../DesignWaterLevelCalculationService.cs) (revision bd73023d5f8926a411da214fb5ce522056a0e30a)
+++ Ringtoets/Common/src/Ringtoets.Common.Service/DesignWaterLevelCalculationService.cs (.../DesignWaterLevelCalculationService.cs) (revision 8e182435811ddd7f9cf29ae57f62b91a2ce5a29c)
@@ -51,7 +51,7 @@
/// The name of the calculation.
/// The file path of the hydraulic boundary database file which to validate.
/// The object which is used to build log messages.
- /// Truec> if there were no validation errors; Falsec> otherwise.
+ /// True if there were no validation errors; False otherwise.
public static bool Validate(string name, string hydraulicBoundaryDatabaseFilePath, ICalculationMessageProvider messageProvider)
{
string calculationName = messageProvider.GetCalculationName(name);
Index: Ringtoets/Common/src/Ringtoets.Common.Service/WaveHeightCalculationService.cs
===================================================================
diff -u -rbd73023d5f8926a411da214fb5ce522056a0e30a -r8e182435811ddd7f9cf29ae57f62b91a2ce5a29c
--- Ringtoets/Common/src/Ringtoets.Common.Service/WaveHeightCalculationService.cs (.../WaveHeightCalculationService.cs) (revision bd73023d5f8926a411da214fb5ce522056a0e30a)
+++ Ringtoets/Common/src/Ringtoets.Common.Service/WaveHeightCalculationService.cs (.../WaveHeightCalculationService.cs) (revision 8e182435811ddd7f9cf29ae57f62b91a2ce5a29c)
@@ -52,7 +52,7 @@
/// The name of the calculation.
/// The file path of the hydraulic boundary database file which to validate.
/// The object which is used to build log messages.
- /// Truec> if there were no validation errors; Falsec> otherwise.
+ /// True if there were no validation errors; False otherwise.
public static bool Validate(string name, string hydraulicBoundaryDatabaseFilePath, ICalculationMessageProvider messageProvider)
{
string calculationName = messageProvider.GetCalculationName(name);
Index: Ringtoets/GrassCoverErosionInwards/src/Ringtoets.GrassCoverErosionInwards.Service/GrassCoverErosionInwardsCalculationService.cs
===================================================================
diff -u -r6279011a954055d718ba3acf1144fc0da8923bf7 -r8e182435811ddd7f9cf29ae57f62b91a2ce5a29c
--- Ringtoets/GrassCoverErosionInwards/src/Ringtoets.GrassCoverErosionInwards.Service/GrassCoverErosionInwardsCalculationService.cs (.../GrassCoverErosionInwardsCalculationService.cs) (revision 6279011a954055d718ba3acf1144fc0da8923bf7)
+++ Ringtoets/GrassCoverErosionInwards/src/Ringtoets.GrassCoverErosionInwards.Service/GrassCoverErosionInwardsCalculationService.cs (.../GrassCoverErosionInwardsCalculationService.cs) (revision 8e182435811ddd7f9cf29ae57f62b91a2ce5a29c)
@@ -59,7 +59,7 @@
///
/// The for which to validate the values.
/// The for which to validate the values.
- /// Truec> if has no validation errors; Falsec> otherwise.
+ /// True if has no validation errors; False otherwise.
public static bool Validate(GrassCoverErosionInwardsCalculation calculation, IAssessmentSection assessmentSection)
{
CalculationServiceHelper.LogValidationBeginTime(calculation.Name);
Index: Ringtoets/GrassCoverErosionOutwards/src/Ringtoets.GrassCoverErosionOutwards.Service/GrassCoverErosionOutwardsWaveConditionsCalculationService.cs
===================================================================
diff -u -r16cb360eae0014270ebb6700054afdbbd565ae65 -r8e182435811ddd7f9cf29ae57f62b91a2ce5a29c
--- Ringtoets/GrassCoverErosionOutwards/src/Ringtoets.GrassCoverErosionOutwards.Service/GrassCoverErosionOutwardsWaveConditionsCalculationService.cs (.../GrassCoverErosionOutwardsWaveConditionsCalculationService.cs) (revision 16cb360eae0014270ebb6700054afdbbd565ae65)
+++ Ringtoets/GrassCoverErosionOutwards/src/Ringtoets.GrassCoverErosionOutwards.Service/GrassCoverErosionOutwardsWaveConditionsCalculationService.cs (.../GrassCoverErosionOutwardsWaveConditionsCalculationService.cs) (revision 8e182435811ddd7f9cf29ae57f62b91a2ce5a29c)
@@ -40,7 +40,7 @@
///
/// The for which to validate the values.
/// The file path of the hydraulic boundary database file which to validate.
- /// Truec> if there were no validation errors; Falsec> otherwise.
+ /// True if there were no validation errors; False otherwise.
public static bool Validate(GrassCoverErosionOutwardsWaveConditionsCalculation calculation, string hydraulicBoundaryDatabaseFilePath)
{
return ValidateWaveConditionsInput(
Index: Ringtoets/HeightStructures/src/Ringtoets.HeightStructures.Service/HeightStructuresCalculationService.cs
===================================================================
diff -u -r6279011a954055d718ba3acf1144fc0da8923bf7 -r8e182435811ddd7f9cf29ae57f62b91a2ce5a29c
--- Ringtoets/HeightStructures/src/Ringtoets.HeightStructures.Service/HeightStructuresCalculationService.cs (.../HeightStructuresCalculationService.cs) (revision 6279011a954055d718ba3acf1144fc0da8923bf7)
+++ Ringtoets/HeightStructures/src/Ringtoets.HeightStructures.Service/HeightStructuresCalculationService.cs (.../HeightStructuresCalculationService.cs) (revision 8e182435811ddd7f9cf29ae57f62b91a2ce5a29c)
@@ -59,7 +59,7 @@
///
/// The for which to validate the values.
/// The for which to validate the values.
- /// Truec> if has no validation errors; Falsec> otherwise.
+ /// True if has no validation errors; False otherwise.
public static bool Validate(StructuresCalculation calculation, IAssessmentSection assessmentSection)
{
CalculationServiceHelper.LogValidationBeginTime(calculation.Name);
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))
Index: Ringtoets/Revetment/src/Ringtoets.Revetment.Service/WaveConditionsCalculationServiceBase.cs
===================================================================
diff -u -r6279011a954055d718ba3acf1144fc0da8923bf7 -r8e182435811ddd7f9cf29ae57f62b91a2ce5a29c
--- Ringtoets/Revetment/src/Ringtoets.Revetment.Service/WaveConditionsCalculationServiceBase.cs (.../WaveConditionsCalculationServiceBase.cs) (revision 6279011a954055d718ba3acf1144fc0da8923bf7)
+++ Ringtoets/Revetment/src/Ringtoets.Revetment.Service/WaveConditionsCalculationServiceBase.cs (.../WaveConditionsCalculationServiceBase.cs) (revision 8e182435811ddd7f9cf29ae57f62b91a2ce5a29c)
@@ -77,7 +77,7 @@
/// The name of the calculation.
/// The directory of the HLCD file that should be used for performing the calculation.
/// The name of the design water level property.
- /// Truec> if has no validation errors; Falsec> otherwise.
+ /// True if has no validation errors; False otherwise.
/// Thrown when is null.
protected static bool ValidateWaveConditionsInput(WaveConditionsInput waveConditionsInput,
string name,
Index: Ringtoets/StabilityPointStructures/src/Ringtoets.StabilityPointStructures.Service/StabilityPointStructuresCalculationService.cs
===================================================================
diff -u -r6279011a954055d718ba3acf1144fc0da8923bf7 -r8e182435811ddd7f9cf29ae57f62b91a2ce5a29c
--- Ringtoets/StabilityPointStructures/src/Ringtoets.StabilityPointStructures.Service/StabilityPointStructuresCalculationService.cs (.../StabilityPointStructuresCalculationService.cs) (revision 6279011a954055d718ba3acf1144fc0da8923bf7)
+++ Ringtoets/StabilityPointStructures/src/Ringtoets.StabilityPointStructures.Service/StabilityPointStructuresCalculationService.cs (.../StabilityPointStructuresCalculationService.cs) (revision 8e182435811ddd7f9cf29ae57f62b91a2ce5a29c)
@@ -60,7 +60,7 @@
///
/// The for which to validate the values.
/// The for which to validate the values.
- /// truec> if has no validation errors; falsec> otherwise.
+ /// true if has no validation errors; false otherwise.
public static bool Validate(StructuresCalculation calculation, IAssessmentSection assessmentSection)
{
CalculationServiceHelper.LogValidationBeginTime(calculation.Name);
Index: Ringtoets/StabilityStoneCover/src/Ringtoets.StabilityStoneCover.Service/StabilityStoneCoverWaveConditionsCalculationService.cs
===================================================================
diff -u -r16cb360eae0014270ebb6700054afdbbd565ae65 -r8e182435811ddd7f9cf29ae57f62b91a2ce5a29c
--- Ringtoets/StabilityStoneCover/src/Ringtoets.StabilityStoneCover.Service/StabilityStoneCoverWaveConditionsCalculationService.cs (.../StabilityStoneCoverWaveConditionsCalculationService.cs) (revision 16cb360eae0014270ebb6700054afdbbd565ae65)
+++ Ringtoets/StabilityStoneCover/src/Ringtoets.StabilityStoneCover.Service/StabilityStoneCoverWaveConditionsCalculationService.cs (.../StabilityStoneCoverWaveConditionsCalculationService.cs) (revision 8e182435811ddd7f9cf29ae57f62b91a2ce5a29c)
@@ -45,7 +45,7 @@
///
/// The for which to validate the values.
/// The file path of the hydraulic boundary database file which to validate.
- /// Truec> if there were no validation errors; Falsec> otherwise.
+ /// True if there were no validation errors; False otherwise.
public static bool Validate(StabilityStoneCoverWaveConditionsCalculation calculation, string hydraulicBoundaryDatabaseFilePath)
{
return ValidateWaveConditionsInput(
Index: Ringtoets/WaveImpactAsphaltCover/src/Ringtoets.WaveImpactAsphaltCover.Service/WaveImpactAsphaltCoverWaveConditionsCalculationService.cs
===================================================================
diff -u -r16cb360eae0014270ebb6700054afdbbd565ae65 -r8e182435811ddd7f9cf29ae57f62b91a2ce5a29c
--- Ringtoets/WaveImpactAsphaltCover/src/Ringtoets.WaveImpactAsphaltCover.Service/WaveImpactAsphaltCoverWaveConditionsCalculationService.cs (.../WaveImpactAsphaltCoverWaveConditionsCalculationService.cs) (revision 16cb360eae0014270ebb6700054afdbbd565ae65)
+++ Ringtoets/WaveImpactAsphaltCover/src/Ringtoets.WaveImpactAsphaltCover.Service/WaveImpactAsphaltCoverWaveConditionsCalculationService.cs (.../WaveImpactAsphaltCoverWaveConditionsCalculationService.cs) (revision 8e182435811ddd7f9cf29ae57f62b91a2ce5a29c)
@@ -40,7 +40,7 @@
///
/// The for which to validate the values.
/// The file path of the hydraulic boundary database file which to validate.
- /// Truec> if there were no validation errors; Falsec> otherwise.
+ /// True if there were no validation errors; False otherwise.
public static bool Validate(WaveImpactAsphaltCoverWaveConditionsCalculation calculation, string hydraulicBoundaryDatabaseFilePath)
{
return ValidateWaveConditionsInput(