diff --git a/src/DocumentFormat.OpenXml.Framework/Validation/DocumentValidator.cs b/src/DocumentFormat.OpenXml.Framework/Validation/DocumentValidator.cs index 855cb7639..df3ea4e46 100644 --- a/src/DocumentFormat.OpenXml.Framework/Validation/DocumentValidator.cs +++ b/src/DocumentFormat.OpenXml.Framework/Validation/DocumentValidator.cs @@ -29,12 +29,18 @@ public DocumentValidator(ValidationCache cache) } /// - /// Validate the specified document. + /// Validates the specified Open XML package against the provided validation settings. /// - /// The document to be validated. - /// The settings to be used during validation. - /// - /// Return results in ValidationResult. + /// The to be validated. + /// The to use during validation. + /// A to observe while waiting for the validation to complete. + /// + /// A list of objects that represent the validation errors found in the package. + /// If no errors are found, the list will be empty. + /// + /// + /// Note: This method can only validate transitional Open XML documents. Strict documents are not supported. + /// public List Validate(OpenXmlPackage document, ValidationSettings settings, CancellationToken token) { var context = new ValidationContext(document.Features.GetNamespaceResolver(), settings, _cache, token); @@ -57,12 +63,18 @@ public List Validate(OpenXmlPackage document, ValidationSet } /// - /// Validate the specified part. + /// Validates the specified Open XML part against the provided validation settings. /// - /// The OpenXmlPart to be validated. - /// The settings to be used during validation. - /// - /// + /// The to be validated. + /// The to use during validation. + /// A to observe while waiting for the validation to complete. + /// + /// A list of objects that represent the validation errors found in the part. + /// If no errors are found, the list will be empty. + /// + /// + /// Note: This method can only validate transitional Open XML documents. Strict documents are not supported. + /// public List Validate(OpenXmlPart part, ValidationSettings settings, CancellationToken token) { var context = new ValidationContext(part.Features.GetNamespaceResolver(), settings, _cache, token);