Index: Ringtoets/Common/src/Ringtoets.Common.IO/Readers/ConfigurationReader.cs
===================================================================
diff -u -re8d6d0512bc28b0af2bd1e8fae1f0bd9e976300c -r1d2bc8f06f058cf7bf75fffa684ceca7961ec1de
--- Ringtoets/Common/src/Ringtoets.Common.IO/Readers/ConfigurationReader.cs (.../ConfigurationReader.cs) (revision e8d6d0512bc28b0af2bd1e8fae1f0bd9e976300c)
+++ Ringtoets/Common/src/Ringtoets.Common.IO/Readers/ConfigurationReader.cs (.../ConfigurationReader.cs) (revision 1d2bc8f06f058cf7bf75fffa684ceca7961ec1de)
@@ -49,23 +49,32 @@
/// Creates a new instance of .
///
/// The file path to the XML file.
- /// A string representing the main schema definition.
+ /// A string representing the main schema definition.
/// A containing
- /// one or more nested schema definitions; the keys should represent unique file names by which
- /// the schema definitions can be referenced from , the
- /// values should represent the corresponding schema definition strings.
+ /// zero to more nested schema definitions. The keys should represent unique file names by which
+ /// the schema definitions can be referenced from ; the
+ /// values should represent their corresponding schema definition string.
+ /// Thrown when
+ /// is null.
/// Thrown when:
///
/// - is invalid.
- /// - is null or empty.
- /// - contains an invalid schema definition.
+ /// - is invalid.
+ /// - contains invalid schema definition values.
+ /// - , all together with its referenced
+ /// , contains an invalid schema definition.
+ /// - contains schema definitions that are not
+ /// referenced by .
+ /// - does not reference the default schema definition
+ /// ConfiguratieSchema.xsd.
///
///
/// Thrown when:
///
/// - points to a file that does not exist.
/// - points to a file that does not contain valid XML.
/// - points to a file that does not pass the schema validation.
+ /// - points to a file that does not contain configuration elements.
///
///
protected ConfigurationReader(string xmlFilePath, string mainSchemaDefinition, IDictionary nestedSchemaDefinitions)
@@ -137,14 +146,14 @@
}
///
- /// Validates the provided XML document based on the provided XML Schema Definition (XSD).
+ /// Validates the provided XML document based on the provided schema definitions.
///
/// The XML document to validate.
- /// A string representing the main schema definition.
- /// A containing
- /// one or more nested schema definitions
/// The file path the XML document is loaded from.
- /// Thrown when the provided XML document does not match the provided XML Schema Definition (XSD).
+ /// A string representing the main schema definition.
+ /// A containing
+ /// zero to more nested schema definitions
+ /// Thrown when the provided XML document does not match the provided schema definitions.
private static void ValidateToSchema(XDocument document, string xmlFilePath, string mainSchemaDefinition, IDictionary nestedSchemaDefinitions)
{
var combinedXmlSchemaDefinition = new CombinedXmlSchemaDefinition(mainSchemaDefinition, nestedSchemaDefinitions
@@ -170,7 +179,7 @@
}
///
- /// Validates whether or not the provided XML document is empty.
+ /// Validates whether the provided XML document is not empty.
///
/// The XML document to validate.
/// The file path the XML document is loaded from.