SA1645.md

SA1645

TypeName	SA1645IncludedDocumentationFileDoesNotExist
CheckId	SA1645
Category	Documentation Rules

:warning: This rule has been intentionally omitted from StyleCop Analyzers. See KnownChanges.md for additional information.

Cause

An included Xml documentation file does not exist.

Rule description

C# syntax provides a mechanism for inserting documentation for classes and elements directly into the code, through the use of Xml documentation headers. For an introduction to these headers and a description of the header syntax, see the following article: https://docs.microsoft.com/en-us/dotnet/csharp/programming-guide/xmldoc/xml-documentation-comments.

As an alternative to authoring documentation directly within the code file, it is possible to place documentation for multiple elements within a separate Xml file, and then reference a section of that file within an element's documentation header. This causes the compiler to import the documentation for that element from the included document. For example:

/// <include file="IncludedDocumentation.xml" path="root/EnabledMethodDocs" />
public bool Enabled(bool true)
{
}

A violation of this rule occurs when the included file does not exist at the given location, or cannot be loaded.

How to fix violations

To fix a violation of this rule, correct the path to the included documentation file to point to a valid file location.

How to suppress violations

[SuppressMessage("StyleCop.CSharp.DocumentationRules", "SA1645:IncludedDocumentationFileDoesNotExist", Justification = "Reviewed.")]

#pragma warning disable SA1645 // IncludedDocumentationFileDoesNotExist
#pragma warning restore SA1645 // IncludedDocumentationFileDoesNotExist