From ae50c00618ed38649092159a5c2cdbe1a742d696 Mon Sep 17 00:00:00 2001 From: vweijsters Date: Tue, 27 Jun 2017 11:38:00 +0200 Subject: [PATCH] Replaced / removed obsolete MSDN magazine URL --- .../DocumentationRules/SA1600ElementsMustBeDocumented.cs | 4 +--- .../SA1601PartialElementsMustBeDocumented.cs | 5 +---- .../SA1602EnumerationItemsMustBeDocumented.cs | 5 +---- .../SA1603DocumentationMustContainValidXml.cs | 5 +---- .../SA1604ElementDocumentationMustHaveSummary.cs | 5 +---- .../SA1605PartialElementDocumentationMustHaveSummary.cs | 5 +---- .../SA1606ElementDocumentationMustHaveSummaryText.cs | 5 +---- .../SA1607PartialElementDocumentationMustHaveSummaryText.cs | 5 +---- .../SA1608ElementDocumentationMustNotHaveDefaultSummary.cs | 5 +---- .../SA1609PropertyDocumentationMustHaveValue.cs | 5 +---- .../SA1610PropertyDocumentationMustHaveValueText.cs | 5 +---- .../SA1611ElementParametersMustBeDocumented.cs | 5 +---- ...lementParameterDocumentationMustMatchElementParameters.cs | 5 +---- ...3ElementParameterDocumentationMustDeclareParameterName.cs | 5 +---- .../SA1614ElementParameterDocumentationMustHaveText.cs | 5 +---- .../SA1615ElementReturnValueMustBeDocumented.cs | 5 +---- .../SA1616ElementReturnValueDocumentationMustHaveText.cs | 5 +---- .../SA1617VoidReturnValueMustNotBeDocumented.cs | 5 +---- .../SA1618GenericTypeParametersMustBeDocumented.cs | 5 +---- ...A1619GenericTypeParametersMustBeDocumentedPartialClass.cs | 5 +---- .../SA1625ElementDocumentationMustNotBeCopiedAndPasted.cs | 5 +---- .../SA1627DocumentationTextMustNotBeEmpty.cs | 5 +---- .../SA1628DocumentationTextMustBeginWithACapitalLetter.cs | 5 +---- .../SA1629DocumentationTextMustEndWithAPeriod.cs | 5 +---- .../SA1630DocumentationTextMustContainWhitespace.cs | 5 +---- .../SA1631DocumentationMustMeetCharacterPercentage.cs | 5 +---- .../SA1632DocumentationTextMustMeetMinimumCharacterLength.cs | 5 +---- ...nstructorSummaryDocumentationMustBeginWithStandardText.cs | 5 +---- ...estructorSummaryDocumentationMustBeginWithStandardText.cs | 5 +---- .../SA1644DocumentationHeadersMustNotContainBlankLines.cs | 5 +---- .../SA1645IncludedDocumentationFileDoesNotExist.cs | 5 +---- .../SA1646IncludedDocumentationXPathDoesNotExist.cs | 5 +---- .../SA1647IncludeNodeDoesNotContainValidFileAndPath.cs | 5 +---- documentation/SA1600.md | 2 +- documentation/SA1601.md | 2 +- documentation/SA1602.md | 2 +- documentation/SA1603.md | 2 +- documentation/SA1604.md | 2 +- documentation/SA1605.md | 2 +- documentation/SA1606.md | 2 +- documentation/SA1607.md | 2 +- documentation/SA1608.md | 2 +- documentation/SA1609.md | 2 +- documentation/SA1610.md | 2 +- documentation/SA1611.md | 2 +- documentation/SA1612.md | 2 +- documentation/SA1613.md | 2 +- documentation/SA1614.md | 2 +- documentation/SA1615.md | 2 +- documentation/SA1616.md | 2 +- documentation/SA1617.md | 2 +- documentation/SA1618.md | 2 +- documentation/SA1619.md | 2 +- documentation/SA1620.md | 2 +- documentation/SA1621.md | 2 +- documentation/SA1622.md | 2 +- documentation/SA1623.md | 2 +- documentation/SA1624.md | 2 +- documentation/SA1625.md | 2 +- documentation/SA1627.md | 2 +- documentation/SA1628.md | 2 +- documentation/SA1629.md | 2 +- documentation/SA1630.md | 2 +- documentation/SA1631.md | 2 +- documentation/SA1632.md | 2 +- documentation/SA1642.md | 2 +- documentation/SA1643.md | 2 +- documentation/SA1644.md | 2 +- documentation/SA1645.md | 2 +- documentation/SA1646.md | 2 +- documentation/SA1647.md | 2 +- 71 files changed, 71 insertions(+), 169 deletions(-) diff --git a/StyleCop.Analyzers/StyleCop.Analyzers/DocumentationRules/SA1600ElementsMustBeDocumented.cs b/StyleCop.Analyzers/StyleCop.Analyzers/DocumentationRules/SA1600ElementsMustBeDocumented.cs index 0b5998ab6..04a002e86 100644 --- a/StyleCop.Analyzers/StyleCop.Analyzers/DocumentationRules/SA1600ElementsMustBeDocumented.cs +++ b/StyleCop.Analyzers/StyleCop.Analyzers/DocumentationRules/SA1600ElementsMustBeDocumented.cs @@ -18,9 +18,7 @@ namespace StyleCop.Analyzers.DocumentationRules /// /// /// 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: - /// . + /// code, through the use of Xml documentation headers. /// /// A violation of this rule occurs if an element is completely missing a documentation header, or if the /// header is empty. In C# the following types of elements can have documentation headers: classes, constructors, diff --git a/StyleCop.Analyzers/StyleCop.Analyzers/DocumentationRules/SA1601PartialElementsMustBeDocumented.cs b/StyleCop.Analyzers/StyleCop.Analyzers/DocumentationRules/SA1601PartialElementsMustBeDocumented.cs index 354fee598..c7d90edb7 100644 --- a/StyleCop.Analyzers/StyleCop.Analyzers/DocumentationRules/SA1601PartialElementsMustBeDocumented.cs +++ b/StyleCop.Analyzers/StyleCop.Analyzers/DocumentationRules/SA1601PartialElementsMustBeDocumented.cs @@ -18,10 +18,7 @@ namespace StyleCop.Analyzers.DocumentationRules /// /// /// 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: - /// XML Comments Let You Build Documentation - /// Directly From Your Visual Studio .NET Source Files. + /// code, through the use of XML documentation headers. /// /// A violation of this rule occurs if a partial element (an element with the partial attribute) is completely /// missing a documentation header, or if the header is empty. In C# the following types of elements can be diff --git a/StyleCop.Analyzers/StyleCop.Analyzers/DocumentationRules/SA1602EnumerationItemsMustBeDocumented.cs b/StyleCop.Analyzers/StyleCop.Analyzers/DocumentationRules/SA1602EnumerationItemsMustBeDocumented.cs index 04522daf7..fc45fc311 100644 --- a/StyleCop.Analyzers/StyleCop.Analyzers/DocumentationRules/SA1602EnumerationItemsMustBeDocumented.cs +++ b/StyleCop.Analyzers/StyleCop.Analyzers/DocumentationRules/SA1602EnumerationItemsMustBeDocumented.cs @@ -17,10 +17,7 @@ namespace StyleCop.Analyzers.DocumentationRules /// /// /// 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: - /// XML Comments Let You Build Documentation - /// Directly From Your Visual Studio .NET Source Files. + /// code, through the use of XML documentation headers. /// /// A violation of this rule occurs when an item within an enumeration is missing a header. For /// example: diff --git a/StyleCop.Analyzers/StyleCop.Analyzers/DocumentationRules/SA1603DocumentationMustContainValidXml.cs b/StyleCop.Analyzers/StyleCop.Analyzers/DocumentationRules/SA1603DocumentationMustContainValidXml.cs index e9742d14e..a51c48333 100644 --- a/StyleCop.Analyzers/StyleCop.Analyzers/DocumentationRules/SA1603DocumentationMustContainValidXml.cs +++ b/StyleCop.Analyzers/StyleCop.Analyzers/DocumentationRules/SA1603DocumentationMustContainValidXml.cs @@ -13,10 +13,7 @@ namespace StyleCop.Analyzers.DocumentationRules /// /// /// 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: - /// XML Comments Let You Build Documentation - /// Directly From Your Visual Studio .NET Source Files. + /// code, through the use of XML documentation headers. /// /// A violation of this rule occurs when the documentation XML is badly formed and cannot be parsed. This can /// occur if the XML contains invalid characters, or if an XML node is missing a closing tag, for example. diff --git a/StyleCop.Analyzers/StyleCop.Analyzers/DocumentationRules/SA1604ElementDocumentationMustHaveSummary.cs b/StyleCop.Analyzers/StyleCop.Analyzers/DocumentationRules/SA1604ElementDocumentationMustHaveSummary.cs index 4d9b96fd6..f86bf90a0 100644 --- a/StyleCop.Analyzers/StyleCop.Analyzers/DocumentationRules/SA1604ElementDocumentationMustHaveSummary.cs +++ b/StyleCop.Analyzers/StyleCop.Analyzers/DocumentationRules/SA1604ElementDocumentationMustHaveSummary.cs @@ -17,10 +17,7 @@ namespace StyleCop.Analyzers.DocumentationRules /// /// /// 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: - /// XML Comments Let You Build Documentation - /// Directly From Your Visual Studio .NET Source Files. + /// code, through the use of XML documentation headers. /// /// A violation of this rule occurs when the element documentation is missing a <summary> /// tag. diff --git a/StyleCop.Analyzers/StyleCop.Analyzers/DocumentationRules/SA1605PartialElementDocumentationMustHaveSummary.cs b/StyleCop.Analyzers/StyleCop.Analyzers/DocumentationRules/SA1605PartialElementDocumentationMustHaveSummary.cs index b3857c160..7a37a3a7c 100644 --- a/StyleCop.Analyzers/StyleCop.Analyzers/DocumentationRules/SA1605PartialElementDocumentationMustHaveSummary.cs +++ b/StyleCop.Analyzers/StyleCop.Analyzers/DocumentationRules/SA1605PartialElementDocumentationMustHaveSummary.cs @@ -17,10 +17,7 @@ namespace StyleCop.Analyzers.DocumentationRules /// /// /// 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: - /// XML Comments Let You Build Documentation - /// Directly From Your Visual Studio .NET Source Files. + /// code, through the use of XML documentation headers. /// /// A violation of this rule occurs when the documentation header for a partial element (an element with the /// partial attribute) is missing a <summary> or <content> tag, or contains an empty diff --git a/StyleCop.Analyzers/StyleCop.Analyzers/DocumentationRules/SA1606ElementDocumentationMustHaveSummaryText.cs b/StyleCop.Analyzers/StyleCop.Analyzers/DocumentationRules/SA1606ElementDocumentationMustHaveSummaryText.cs index 2d8dde083..f314fb531 100644 --- a/StyleCop.Analyzers/StyleCop.Analyzers/DocumentationRules/SA1606ElementDocumentationMustHaveSummaryText.cs +++ b/StyleCop.Analyzers/StyleCop.Analyzers/DocumentationRules/SA1606ElementDocumentationMustHaveSummaryText.cs @@ -16,10 +16,7 @@ namespace StyleCop.Analyzers.DocumentationRules /// /// /// 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: - /// XML Comments Let You Build Documentation - /// Directly From Your Visual Studio .NET Source Files. + /// code, through the use of XML documentation headers. /// /// A violation of this rule occurs when the documentation header for an element contains an empty /// <summary> tag which does not contain a description of the element. diff --git a/StyleCop.Analyzers/StyleCop.Analyzers/DocumentationRules/SA1607PartialElementDocumentationMustHaveSummaryText.cs b/StyleCop.Analyzers/StyleCop.Analyzers/DocumentationRules/SA1607PartialElementDocumentationMustHaveSummaryText.cs index e4ecbee93..b13cfd90b 100644 --- a/StyleCop.Analyzers/StyleCop.Analyzers/DocumentationRules/SA1607PartialElementDocumentationMustHaveSummaryText.cs +++ b/StyleCop.Analyzers/StyleCop.Analyzers/DocumentationRules/SA1607PartialElementDocumentationMustHaveSummaryText.cs @@ -17,10 +17,7 @@ namespace StyleCop.Analyzers.DocumentationRules /// /// /// 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: - /// XML Comments Let You Build Documentation - /// Directly From Your Visual Studio .NET Source Files. + /// code, through the use of XML documentation headers. /// /// A violation of this rule occurs when the documentation header for a partial element (an element with the /// partial attribute) contains an empty <summary> tag or <content> tag which does not diff --git a/StyleCop.Analyzers/StyleCop.Analyzers/DocumentationRules/SA1608ElementDocumentationMustNotHaveDefaultSummary.cs b/StyleCop.Analyzers/StyleCop.Analyzers/DocumentationRules/SA1608ElementDocumentationMustNotHaveDefaultSummary.cs index b5d8ef286..3aa2f1e1d 100644 --- a/StyleCop.Analyzers/StyleCop.Analyzers/DocumentationRules/SA1608ElementDocumentationMustNotHaveDefaultSummary.cs +++ b/StyleCop.Analyzers/StyleCop.Analyzers/DocumentationRules/SA1608ElementDocumentationMustNotHaveDefaultSummary.cs @@ -19,10 +19,7 @@ namespace StyleCop.Analyzers.DocumentationRules /// /// /// 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: - /// XML Comments Let You Build Documentation - /// Directly From Your Visual Studio .NET Source Files. + /// code, through the use of XML documentation headers. /// /// Visual Studio provides helper functionality for adding new elements such as classes to a project. Visual /// Studio will create a default documentation header for the new class and fill in this header with default diff --git a/StyleCop.Analyzers/StyleCop.Analyzers/DocumentationRules/SA1609PropertyDocumentationMustHaveValue.cs b/StyleCop.Analyzers/StyleCop.Analyzers/DocumentationRules/SA1609PropertyDocumentationMustHaveValue.cs index e29af1f7a..d85dde471 100644 --- a/StyleCop.Analyzers/StyleCop.Analyzers/DocumentationRules/SA1609PropertyDocumentationMustHaveValue.cs +++ b/StyleCop.Analyzers/StyleCop.Analyzers/DocumentationRules/SA1609PropertyDocumentationMustHaveValue.cs @@ -16,10 +16,7 @@ namespace StyleCop.Analyzers.DocumentationRules /// /// /// 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: - /// XML Comments Let You Build Documentation - /// Directly From Your Visual Studio .NET Source Files. + /// code, through the use of XML documentation headers. /// /// The documentation for properties may include a <value> tag, which describes the value held by /// the property. diff --git a/StyleCop.Analyzers/StyleCop.Analyzers/DocumentationRules/SA1610PropertyDocumentationMustHaveValueText.cs b/StyleCop.Analyzers/StyleCop.Analyzers/DocumentationRules/SA1610PropertyDocumentationMustHaveValueText.cs index 6a71df268..da78bf32c 100644 --- a/StyleCop.Analyzers/StyleCop.Analyzers/DocumentationRules/SA1610PropertyDocumentationMustHaveValueText.cs +++ b/StyleCop.Analyzers/StyleCop.Analyzers/DocumentationRules/SA1610PropertyDocumentationMustHaveValueText.cs @@ -16,10 +16,7 @@ namespace StyleCop.Analyzers.DocumentationRules /// /// /// 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: - /// XML Comments Let You Build Documentation - /// Directly From Your Visual Studio .NET Source Files. + /// code, through the use of XML documentation headers. /// /// The documentation for properties may include a <value> tag, which describes the value held by /// the property. diff --git a/StyleCop.Analyzers/StyleCop.Analyzers/DocumentationRules/SA1611ElementParametersMustBeDocumented.cs b/StyleCop.Analyzers/StyleCop.Analyzers/DocumentationRules/SA1611ElementParametersMustBeDocumented.cs index fb492fb72..7b29cdced 100644 --- a/StyleCop.Analyzers/StyleCop.Analyzers/DocumentationRules/SA1611ElementParametersMustBeDocumented.cs +++ b/StyleCop.Analyzers/StyleCop.Analyzers/DocumentationRules/SA1611ElementParametersMustBeDocumented.cs @@ -18,10 +18,7 @@ namespace StyleCop.Analyzers.DocumentationRules /// /// /// 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: - /// XML Comments Let You Build Documentation - /// Directly From Your Visual Studio .NET Source Files. + /// code, through the use of XML documentation headers. /// /// A violation of this rule occurs if an element containing parameters is missing documentation for one or /// more of its parameters. diff --git a/StyleCop.Analyzers/StyleCop.Analyzers/DocumentationRules/SA1612ElementParameterDocumentationMustMatchElementParameters.cs b/StyleCop.Analyzers/StyleCop.Analyzers/DocumentationRules/SA1612ElementParameterDocumentationMustMatchElementParameters.cs index ed35f04ff..aca7fb6f9 100644 --- a/StyleCop.Analyzers/StyleCop.Analyzers/DocumentationRules/SA1612ElementParameterDocumentationMustMatchElementParameters.cs +++ b/StyleCop.Analyzers/StyleCop.Analyzers/DocumentationRules/SA1612ElementParameterDocumentationMustMatchElementParameters.cs @@ -18,10 +18,7 @@ namespace StyleCop.Analyzers.DocumentationRules /// /// /// 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: - /// XML Comments Let You Build Documentation - /// Directly From Your Visual Studio .NET Source Files. + /// code, through the use of XML documentation headers. /// /// A violation of this rule occurs if the documentation for an element's parameters does not match the actual /// parameters on the element, or if the parameter documentation is not listed in the same order as the element's parameters. diff --git a/StyleCop.Analyzers/StyleCop.Analyzers/DocumentationRules/SA1613ElementParameterDocumentationMustDeclareParameterName.cs b/StyleCop.Analyzers/StyleCop.Analyzers/DocumentationRules/SA1613ElementParameterDocumentationMustDeclareParameterName.cs index 8905cfaa0..6a1a7f411 100644 --- a/StyleCop.Analyzers/StyleCop.Analyzers/DocumentationRules/SA1613ElementParameterDocumentationMustDeclareParameterName.cs +++ b/StyleCop.Analyzers/StyleCop.Analyzers/DocumentationRules/SA1613ElementParameterDocumentationMustDeclareParameterName.cs @@ -18,10 +18,7 @@ namespace StyleCop.Analyzers.DocumentationRules /// /// /// 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: - /// XML Comments Let You Build Documentation - /// Directly From Your Visual Studio .NET Source Files. + /// code, through the use of XML documentation headers. /// /// A violation of this rule occurs if the documentation for an element contains a <param> tag /// which is missing a name attribute, or which contains an empty name attribute. diff --git a/StyleCop.Analyzers/StyleCop.Analyzers/DocumentationRules/SA1614ElementParameterDocumentationMustHaveText.cs b/StyleCop.Analyzers/StyleCop.Analyzers/DocumentationRules/SA1614ElementParameterDocumentationMustHaveText.cs index 70bd36d62..d1143f09f 100644 --- a/StyleCop.Analyzers/StyleCop.Analyzers/DocumentationRules/SA1614ElementParameterDocumentationMustHaveText.cs +++ b/StyleCop.Analyzers/StyleCop.Analyzers/DocumentationRules/SA1614ElementParameterDocumentationMustHaveText.cs @@ -17,10 +17,7 @@ namespace StyleCop.Analyzers.DocumentationRules /// /// /// 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: - /// XML Comments Let You Build Documentation - /// Directly From Your Visual Studio .NET Source Files. + /// code, through the use of XML documentation headers. /// /// A violation of this rule occurs if the documentation for an element contains a <param> tag /// which is empty and does not contain a description of the parameter. diff --git a/StyleCop.Analyzers/StyleCop.Analyzers/DocumentationRules/SA1615ElementReturnValueMustBeDocumented.cs b/StyleCop.Analyzers/StyleCop.Analyzers/DocumentationRules/SA1615ElementReturnValueMustBeDocumented.cs index 04d8c6c2f..032184bc0 100644 --- a/StyleCop.Analyzers/StyleCop.Analyzers/DocumentationRules/SA1615ElementReturnValueMustBeDocumented.cs +++ b/StyleCop.Analyzers/StyleCop.Analyzers/DocumentationRules/SA1615ElementReturnValueMustBeDocumented.cs @@ -19,10 +19,7 @@ namespace StyleCop.Analyzers.DocumentationRules /// /// /// 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: - /// XML Comments Let You Build Documentation - /// Directly From Your Visual Studio .NET Source Files. + /// code, through the use of XML documentation headers. /// /// A violation of this rule occurs if an element containing a return value is missing a /// <returns> tag. diff --git a/StyleCop.Analyzers/StyleCop.Analyzers/DocumentationRules/SA1616ElementReturnValueDocumentationMustHaveText.cs b/StyleCop.Analyzers/StyleCop.Analyzers/DocumentationRules/SA1616ElementReturnValueDocumentationMustHaveText.cs index 2d49a3b38..c91aaa29d 100644 --- a/StyleCop.Analyzers/StyleCop.Analyzers/DocumentationRules/SA1616ElementReturnValueDocumentationMustHaveText.cs +++ b/StyleCop.Analyzers/StyleCop.Analyzers/DocumentationRules/SA1616ElementReturnValueDocumentationMustHaveText.cs @@ -17,10 +17,7 @@ namespace StyleCop.Analyzers.DocumentationRules /// /// /// 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: - /// XML Comments Let You Build Documentation - /// Directly From Your Visual Studio .NET Source Files. + /// code, through the use of XML documentation headers. /// /// A violation of this rule occurs if an element contains an empty <returns> tag. /// diff --git a/StyleCop.Analyzers/StyleCop.Analyzers/DocumentationRules/SA1617VoidReturnValueMustNotBeDocumented.cs b/StyleCop.Analyzers/StyleCop.Analyzers/DocumentationRules/SA1617VoidReturnValueMustNotBeDocumented.cs index 5e0489198..1208cc930 100644 --- a/StyleCop.Analyzers/StyleCop.Analyzers/DocumentationRules/SA1617VoidReturnValueMustNotBeDocumented.cs +++ b/StyleCop.Analyzers/StyleCop.Analyzers/DocumentationRules/SA1617VoidReturnValueMustNotBeDocumented.cs @@ -19,10 +19,7 @@ namespace StyleCop.Analyzers.DocumentationRules /// /// /// 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: - /// XML Comments Let You Build Documentation - /// Directly From Your Visual Studio .NET Source Files. + /// code, through the use of XML documentation headers. /// /// A violation of this rule occurs if an element which returns void contains a <returns> /// tag within its documentation header. diff --git a/StyleCop.Analyzers/StyleCop.Analyzers/DocumentationRules/SA1618GenericTypeParametersMustBeDocumented.cs b/StyleCop.Analyzers/StyleCop.Analyzers/DocumentationRules/SA1618GenericTypeParametersMustBeDocumented.cs index 36fb81b15..0aa25feb0 100644 --- a/StyleCop.Analyzers/StyleCop.Analyzers/DocumentationRules/SA1618GenericTypeParametersMustBeDocumented.cs +++ b/StyleCop.Analyzers/StyleCop.Analyzers/DocumentationRules/SA1618GenericTypeParametersMustBeDocumented.cs @@ -19,10 +19,7 @@ namespace StyleCop.Analyzers.DocumentationRules /// /// /// 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: - /// XML Comments Let You Build Documentation - /// Directly From Your Visual Studio .NET Source Files. + /// code, through the use of XML documentation headers. /// /// A violation of this rule occurs if an element containing generic type parameters is missing documentation /// for one or more of its generic type parameters. diff --git a/StyleCop.Analyzers/StyleCop.Analyzers/DocumentationRules/SA1619GenericTypeParametersMustBeDocumentedPartialClass.cs b/StyleCop.Analyzers/StyleCop.Analyzers/DocumentationRules/SA1619GenericTypeParametersMustBeDocumentedPartialClass.cs index 26d081764..e9fcc02ae 100644 --- a/StyleCop.Analyzers/StyleCop.Analyzers/DocumentationRules/SA1619GenericTypeParametersMustBeDocumentedPartialClass.cs +++ b/StyleCop.Analyzers/StyleCop.Analyzers/DocumentationRules/SA1619GenericTypeParametersMustBeDocumentedPartialClass.cs @@ -20,10 +20,7 @@ namespace StyleCop.Analyzers.DocumentationRules /// /// /// 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: - /// XML Comments Let You Build Documentation - /// Directly From Your Visual Studio .NET Source Files. + /// code, through the use of XML documentation headers. /// /// A violation of this rule occurs when a generic, partial element is missing documentation for one or more /// of its generic type parameters, and the documentation for the element contains a <summary> tag diff --git a/StyleCop.Analyzers/StyleCop.Analyzers/DocumentationRules/SA1625ElementDocumentationMustNotBeCopiedAndPasted.cs b/StyleCop.Analyzers/StyleCop.Analyzers/DocumentationRules/SA1625ElementDocumentationMustNotBeCopiedAndPasted.cs index 5add938a6..2bce19fe5 100644 --- a/StyleCop.Analyzers/StyleCop.Analyzers/DocumentationRules/SA1625ElementDocumentationMustNotBeCopiedAndPasted.cs +++ b/StyleCop.Analyzers/StyleCop.Analyzers/DocumentationRules/SA1625ElementDocumentationMustNotBeCopiedAndPasted.cs @@ -22,10 +22,7 @@ namespace StyleCop.Analyzers.DocumentationRules /// /// /// 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: - /// XML Comments Let You Build Documentation - /// Directly From Your Visual Studio .NET Source Files. + /// code, through the use of XML documentation headers. /// /// A violation of this rule occurs when an element contains two or more identical documentation texts. For /// example: diff --git a/StyleCop.Analyzers/StyleCop.Analyzers/DocumentationRules/SA1627DocumentationTextMustNotBeEmpty.cs b/StyleCop.Analyzers/StyleCop.Analyzers/DocumentationRules/SA1627DocumentationTextMustNotBeEmpty.cs index c8c81fd08..b9fee710e 100644 --- a/StyleCop.Analyzers/StyleCop.Analyzers/DocumentationRules/SA1627DocumentationTextMustNotBeEmpty.cs +++ b/StyleCop.Analyzers/StyleCop.Analyzers/DocumentationRules/SA1627DocumentationTextMustNotBeEmpty.cs @@ -18,10 +18,7 @@ namespace StyleCop.Analyzers.DocumentationRules /// /// /// 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: - /// XML Comments Let You Build Documentation - /// Directly From Your Visual Studio .NET Source Files. + /// code, through the use of XML documentation headers. /// /// A violation of this rule occurs when the documentation header for an element contains an empty tag. For /// example: diff --git a/StyleCop.Analyzers/StyleCop.Analyzers/DocumentationRules/SA1628DocumentationTextMustBeginWithACapitalLetter.cs b/StyleCop.Analyzers/StyleCop.Analyzers/DocumentationRules/SA1628DocumentationTextMustBeginWithACapitalLetter.cs index dfd12f5be..fed41c1d1 100644 --- a/StyleCop.Analyzers/StyleCop.Analyzers/DocumentationRules/SA1628DocumentationTextMustBeginWithACapitalLetter.cs +++ b/StyleCop.Analyzers/StyleCop.Analyzers/DocumentationRules/SA1628DocumentationTextMustBeginWithACapitalLetter.cs @@ -15,10 +15,7 @@ namespace StyleCop.Analyzers.DocumentationRules /// This diagnostic is not implemented in StyleCopAnalyzers. /// /// 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: - /// XML Comments Let You Build Documentation - /// Directly From Your Visual Studio .NET Source Files. + /// code, through the use of XML documentation headers. /// /// A violation of this rule occurs when part of the documentation does not begin with a capital letter. For /// example, the summary text in the documentation below begins with a lower-case letter: diff --git a/StyleCop.Analyzers/StyleCop.Analyzers/DocumentationRules/SA1629DocumentationTextMustEndWithAPeriod.cs b/StyleCop.Analyzers/StyleCop.Analyzers/DocumentationRules/SA1629DocumentationTextMustEndWithAPeriod.cs index c689717bd..0664c9f6a 100644 --- a/StyleCop.Analyzers/StyleCop.Analyzers/DocumentationRules/SA1629DocumentationTextMustEndWithAPeriod.cs +++ b/StyleCop.Analyzers/StyleCop.Analyzers/DocumentationRules/SA1629DocumentationTextMustEndWithAPeriod.cs @@ -13,10 +13,7 @@ namespace StyleCop.Analyzers.DocumentationRules /// /// /// 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: - /// XML Comments Let You Build Documentation - /// Directly From Your Visual Studio .NET Source Files. + /// code, through the use of XML documentation headers. /// /// A violation of this rule occurs when part of the documentation does not end with a period. For example, /// the summary text in the documentation below does not end with a period: diff --git a/StyleCop.Analyzers/StyleCop.Analyzers/DocumentationRules/SA1630DocumentationTextMustContainWhitespace.cs b/StyleCop.Analyzers/StyleCop.Analyzers/DocumentationRules/SA1630DocumentationTextMustContainWhitespace.cs index 3160f05f0..5a9aa6ec8 100644 --- a/StyleCop.Analyzers/StyleCop.Analyzers/DocumentationRules/SA1630DocumentationTextMustContainWhitespace.cs +++ b/StyleCop.Analyzers/StyleCop.Analyzers/DocumentationRules/SA1630DocumentationTextMustContainWhitespace.cs @@ -15,10 +15,7 @@ namespace StyleCop.Analyzers.DocumentationRules /// This diagnostic is not implemented in StyleCopAnalyzers. /// /// 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: - /// XML Comments Let You Build Documentation - /// Directly From Your Visual Studio .NET Source Files. + /// code, through the use of XML documentation headers. /// /// A violation of this rule occurs when part of the documentation does contain any whitespace between words. /// This can indicate poorly written or poorly formatted documentation. For example: diff --git a/StyleCop.Analyzers/StyleCop.Analyzers/DocumentationRules/SA1631DocumentationMustMeetCharacterPercentage.cs b/StyleCop.Analyzers/StyleCop.Analyzers/DocumentationRules/SA1631DocumentationMustMeetCharacterPercentage.cs index b2c8b6b98..8cfdf86b4 100644 --- a/StyleCop.Analyzers/StyleCop.Analyzers/DocumentationRules/SA1631DocumentationMustMeetCharacterPercentage.cs +++ b/StyleCop.Analyzers/StyleCop.Analyzers/DocumentationRules/SA1631DocumentationMustMeetCharacterPercentage.cs @@ -15,10 +15,7 @@ namespace StyleCop.Analyzers.DocumentationRules /// This diagnostic is not implemented in StyleCopAnalyzers. /// /// 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: - /// XML Comments Let You Build Documentation - /// Directly From Your Visual Studio .NET Source Files. + /// code, through the use of XML documentation headers. /// /// A violation of this rule occurs when part of the documentation does contain enough characters. This rule /// is calculated by counting the number of alphabetic characters and numbers within the documentation text, and diff --git a/StyleCop.Analyzers/StyleCop.Analyzers/DocumentationRules/SA1632DocumentationTextMustMeetMinimumCharacterLength.cs b/StyleCop.Analyzers/StyleCop.Analyzers/DocumentationRules/SA1632DocumentationTextMustMeetMinimumCharacterLength.cs index fea40c207..2538d0972 100644 --- a/StyleCop.Analyzers/StyleCop.Analyzers/DocumentationRules/SA1632DocumentationTextMustMeetMinimumCharacterLength.cs +++ b/StyleCop.Analyzers/StyleCop.Analyzers/DocumentationRules/SA1632DocumentationTextMustMeetMinimumCharacterLength.cs @@ -16,10 +16,7 @@ namespace StyleCop.Analyzers.DocumentationRules /// This diagnostic is not implemented in StyleCopAnalyzers. /// /// 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: - /// XML Comments Let You Build Documentation - /// Directly From Your Visual Studio .NET Source Files. + /// code, through the use of XML documentation headers. /// /// A violation of this rule occurs when part of the documentation is too short. This can often indicate that /// the documentation is not descriptive. For example: diff --git a/StyleCop.Analyzers/StyleCop.Analyzers/DocumentationRules/SA1642ConstructorSummaryDocumentationMustBeginWithStandardText.cs b/StyleCop.Analyzers/StyleCop.Analyzers/DocumentationRules/SA1642ConstructorSummaryDocumentationMustBeginWithStandardText.cs index e77333f10..568b8ecfb 100644 --- a/StyleCop.Analyzers/StyleCop.Analyzers/DocumentationRules/SA1642ConstructorSummaryDocumentationMustBeginWithStandardText.cs +++ b/StyleCop.Analyzers/StyleCop.Analyzers/DocumentationRules/SA1642ConstructorSummaryDocumentationMustBeginWithStandardText.cs @@ -17,10 +17,7 @@ namespace StyleCop.Analyzers.DocumentationRules /// /// /// 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: - /// XML Comments Let You Build Documentation - /// Directly From Your Visual Studio .NET Source Files. + /// code, through the use of XML documentation headers. /// /// A violation of this rule occurs when the summary tag within the documentation header for a constructor /// does not begin with the proper text. diff --git a/StyleCop.Analyzers/StyleCop.Analyzers/DocumentationRules/SA1643DestructorSummaryDocumentationMustBeginWithStandardText.cs b/StyleCop.Analyzers/StyleCop.Analyzers/DocumentationRules/SA1643DestructorSummaryDocumentationMustBeginWithStandardText.cs index c9e84fe87..9e02662b5 100644 --- a/StyleCop.Analyzers/StyleCop.Analyzers/DocumentationRules/SA1643DestructorSummaryDocumentationMustBeginWithStandardText.cs +++ b/StyleCop.Analyzers/StyleCop.Analyzers/DocumentationRules/SA1643DestructorSummaryDocumentationMustBeginWithStandardText.cs @@ -16,10 +16,7 @@ namespace StyleCop.Analyzers.DocumentationRules /// /// /// 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: - /// XML Comments Let You Build Documentation - /// Directly From Your Visual Studio .NET Source Files. + /// code, through the use of XML documentation headers. /// /// A violation of this rule occurs when the summary tag within the documentation header for a finalizer does /// not begin with the proper text. diff --git a/StyleCop.Analyzers/StyleCop.Analyzers/DocumentationRules/SA1644DocumentationHeadersMustNotContainBlankLines.cs b/StyleCop.Analyzers/StyleCop.Analyzers/DocumentationRules/SA1644DocumentationHeadersMustNotContainBlankLines.cs index 125f01c27..4c06f4fb0 100644 --- a/StyleCop.Analyzers/StyleCop.Analyzers/DocumentationRules/SA1644DocumentationHeadersMustNotContainBlankLines.cs +++ b/StyleCop.Analyzers/StyleCop.Analyzers/DocumentationRules/SA1644DocumentationHeadersMustNotContainBlankLines.cs @@ -12,10 +12,7 @@ namespace StyleCop.Analyzers.DocumentationRules /// /// /// 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: - /// XML Comments Let You Build Documentation - /// Directly From Your Visual Studio .NET Source Files. + /// code, through the use of XML documentation headers. /// /// A violation of this rule occurs when the documentation header contains one or more blank lines within a /// section of documentation. For example: diff --git a/StyleCop.Analyzers/StyleCop.Analyzers/DocumentationRules/SA1645IncludedDocumentationFileDoesNotExist.cs b/StyleCop.Analyzers/StyleCop.Analyzers/DocumentationRules/SA1645IncludedDocumentationFileDoesNotExist.cs index f51f46cc7..82dd46559 100644 --- a/StyleCop.Analyzers/StyleCop.Analyzers/DocumentationRules/SA1645IncludedDocumentationFileDoesNotExist.cs +++ b/StyleCop.Analyzers/StyleCop.Analyzers/DocumentationRules/SA1645IncludedDocumentationFileDoesNotExist.cs @@ -13,10 +13,7 @@ namespace StyleCop.Analyzers.DocumentationRules /// /// /// 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: - /// XML Comments Let You Build Documentation - /// Directly From Your Visual Studio .NET Source Files. + /// code, through the use of XML documentation headers. /// /// 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 diff --git a/StyleCop.Analyzers/StyleCop.Analyzers/DocumentationRules/SA1646IncludedDocumentationXPathDoesNotExist.cs b/StyleCop.Analyzers/StyleCop.Analyzers/DocumentationRules/SA1646IncludedDocumentationXPathDoesNotExist.cs index c7c705866..dae33f6c9 100644 --- a/StyleCop.Analyzers/StyleCop.Analyzers/DocumentationRules/SA1646IncludedDocumentationXPathDoesNotExist.cs +++ b/StyleCop.Analyzers/StyleCop.Analyzers/DocumentationRules/SA1646IncludedDocumentationXPathDoesNotExist.cs @@ -13,10 +13,7 @@ namespace StyleCop.Analyzers.DocumentationRules /// /// /// 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: - /// XML Comments Let You Build Documentation - /// Directly From Your Visual Studio .NET Source Files. + /// code, through the use of XML documentation headers. /// /// 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 diff --git a/StyleCop.Analyzers/StyleCop.Analyzers/DocumentationRules/SA1647IncludeNodeDoesNotContainValidFileAndPath.cs b/StyleCop.Analyzers/StyleCop.Analyzers/DocumentationRules/SA1647IncludeNodeDoesNotContainValidFileAndPath.cs index 79cd5f456..294441862 100644 --- a/StyleCop.Analyzers/StyleCop.Analyzers/DocumentationRules/SA1647IncludeNodeDoesNotContainValidFileAndPath.cs +++ b/StyleCop.Analyzers/StyleCop.Analyzers/DocumentationRules/SA1647IncludeNodeDoesNotContainValidFileAndPath.cs @@ -13,10 +13,7 @@ namespace StyleCop.Analyzers.DocumentationRules /// /// /// 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: - /// XML Comments Let You Build Documentation - /// Directly From Your Visual Studio .NET Source Files. + /// code, through the use of XML documentation headers. /// /// 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 diff --git a/documentation/SA1600.md b/documentation/SA1600.md index cc39ce565..d38259cc5 100644 --- a/documentation/SA1600.md +++ b/documentation/SA1600.md @@ -21,7 +21,7 @@ A C# code element is missing a documentation header. ## 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: [http://msdn.microsoft.com/en-us/magazine/cc302121.aspx](http://msdn.microsoft.com/en-us/magazine/cc302121.aspx). +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](https://docs.microsoft.com/en-us/dotnet/csharp/programming-guide/xmldoc/xml-documentation-comments). A violation of this rule occurs if an element is completely missing a documentation header, or if the header is empty. In C# the following types of elements can have documentation headers: classes, constructors, delegates, enums, events, finalizers, indexers, interfaces, methods, properties, and structs. diff --git a/documentation/SA1601.md b/documentation/SA1601.md index 0cbc8ff19..2ea1c87f8 100644 --- a/documentation/SA1601.md +++ b/documentation/SA1601.md @@ -21,7 +21,7 @@ A C# partial element is missing a documentation header. ## 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: [http://msdn.microsoft.com/en-us/magazine/cc302121.aspx](http://msdn.microsoft.com/en-us/magazine/cc302121.aspx). +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](https://docs.microsoft.com/en-us/dotnet/csharp/programming-guide/xmldoc/xml-documentation-comments). A violation of this rule occurs if a partial element (an element with the partial attribute) is completely missing a documentation header, or if the header is empty. In C# the following types of elements can be attributed with the partial attribute: classes, methods. diff --git a/documentation/SA1602.md b/documentation/SA1602.md index ecde8f94d..a6b40bc6a 100644 --- a/documentation/SA1602.md +++ b/documentation/SA1602.md @@ -21,7 +21,7 @@ An item within a C# enumeration is missing an Xml documentation header. ## 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: [http://msdn.microsoft.com/en-us/magazine/cc302121.aspx](http://msdn.microsoft.com/en-us/magazine/cc302121.aspx). +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](https://docs.microsoft.com/en-us/dotnet/csharp/programming-guide/xmldoc/xml-documentation-comments). A violation of this rule occurs when an item within an enumeration is missing a header. For example: diff --git a/documentation/SA1603.md b/documentation/SA1603.md index 84665d800..613ab9d31 100644 --- a/documentation/SA1603.md +++ b/documentation/SA1603.md @@ -24,7 +24,7 @@ The Xml within a C# element's document header is badly formed. ## 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: [http://msdn.microsoft.com/en-us/magazine/cc302121.aspx](http://msdn.microsoft.com/en-us/magazine/cc302121.aspx). +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](https://docs.microsoft.com/en-us/dotnet/csharp/programming-guide/xmldoc/xml-documentation-comments). A violation of this rule occurs when the documentation Xml is badly formed and cannot be parsed. This can occur if the Xml contains invalid characters, or if an Xml node is missing a closing tag, for example. diff --git a/documentation/SA1604.md b/documentation/SA1604.md index a21a1435c..768b20dc2 100644 --- a/documentation/SA1604.md +++ b/documentation/SA1604.md @@ -21,7 +21,7 @@ The Xml header documentation for a C# element is missing a `` tag. ## 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: [http://msdn.microsoft.com/en-us/magazine/cc302121.aspx](http://msdn.microsoft.com/en-us/magazine/cc302121.aspx). +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](https://docs.microsoft.com/en-us/dotnet/csharp/programming-guide/xmldoc/xml-documentation-comments). A violation of this rule occurs when the element documentation is missing a `` tag. diff --git a/documentation/SA1605.md b/documentation/SA1605.md index 2593f66d9..0c8632560 100644 --- a/documentation/SA1605.md +++ b/documentation/SA1605.md @@ -21,7 +21,7 @@ The `` or `` tag within the documentation header for a C# code ## 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: [http://msdn.microsoft.com/en-us/magazine/cc302121.aspx](http://msdn.microsoft.com/en-us/magazine/cc302121.aspx). +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](https://docs.microsoft.com/en-us/dotnet/csharp/programming-guide/xmldoc/xml-documentation-comments). A violation of this rule occurs when the documentation header for a partial element (an element with the partial attribute) is missing a `` or `` tag, or contains an empty `` or `` tag which does not contain a description of the element. In C# the following types of elements can be attributed with the partial attribute: classes, methods. diff --git a/documentation/SA1606.md b/documentation/SA1606.md index 47427f907..e45380fb3 100644 --- a/documentation/SA1606.md +++ b/documentation/SA1606.md @@ -21,7 +21,7 @@ The `` tag within the documentation header for a C# code element is emp ## 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: [http://msdn.microsoft.com/en-us/magazine/cc302121.aspx](http://msdn.microsoft.com/en-us/magazine/cc302121.aspx). +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](https://docs.microsoft.com/en-us/dotnet/csharp/programming-guide/xmldoc/xml-documentation-comments). A violation of this rule occurs when the documentation header for an element contains an empty `` tag which does not contain a description of the element. diff --git a/documentation/SA1607.md b/documentation/SA1607.md index f826ee706..2cd330a02 100644 --- a/documentation/SA1607.md +++ b/documentation/SA1607.md @@ -21,7 +21,7 @@ The `` or `` tag within the documentation header for a C# code ## 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: [http://msdn.microsoft.com/en-us/magazine/cc302121.aspx](http://msdn.microsoft.com/en-us/magazine/cc302121.aspx). +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](https://docs.microsoft.com/en-us/dotnet/csharp/programming-guide/xmldoc/xml-documentation-comments). A violation of this rule occurs when the documentation header for a partial element (an element with the partial attribute) contains an empty `` tag or `` tag which does not contain a description of the element. In C# the following types of elements can be attributed with the partial attribute: classes, methods. diff --git a/documentation/SA1608.md b/documentation/SA1608.md index 90b204dab..1a2c20708 100644 --- a/documentation/SA1608.md +++ b/documentation/SA1608.md @@ -21,7 +21,7 @@ The `` tag within an element's Xml header documentation contains the de ## 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: [http://msdn.microsoft.com/en-us/magazine/cc302121.aspx](http://msdn.microsoft.com/en-us/magazine/cc302121.aspx). +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](https://docs.microsoft.com/en-us/dotnet/csharp/programming-guide/xmldoc/xml-documentation-comments). Visual Studio provides helper functionality for adding new elements such as classes to a project. Visual Studio will create a default documentation header for the new class and fill in this header with default documentation text. diff --git a/documentation/SA1609.md b/documentation/SA1609.md index 85fb727ad..b574c7bdc 100644 --- a/documentation/SA1609.md +++ b/documentation/SA1609.md @@ -21,7 +21,7 @@ The Xml header documentation for a C# property does not contain a `` tag. ## 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: [http://msdn.microsoft.com/en-us/magazine/cc302121.aspx](http://msdn.microsoft.com/en-us/magazine/cc302121.aspx). +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](https://docs.microsoft.com/en-us/dotnet/csharp/programming-guide/xmldoc/xml-documentation-comments). The documentation for properties may include a `` tag, which describes the value held by the property. diff --git a/documentation/SA1610.md b/documentation/SA1610.md index 4493f9ef7..7b778ffdb 100644 --- a/documentation/SA1610.md +++ b/documentation/SA1610.md @@ -21,7 +21,7 @@ The Xml header documentation for a C# property contains an empty `` tag. ## 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: [http://msdn.microsoft.com/en-us/magazine/cc302121.aspx](http://msdn.microsoft.com/en-us/magazine/cc302121.aspx). +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](https://docs.microsoft.com/en-us/dotnet/csharp/programming-guide/xmldoc/xml-documentation-comments). The documentation for properties may include a `` tag, which describes the value held by the property. diff --git a/documentation/SA1611.md b/documentation/SA1611.md index 51aab7579..c5316b553 100644 --- a/documentation/SA1611.md +++ b/documentation/SA1611.md @@ -21,7 +21,7 @@ A C# method, constructor, delegate or indexer element is missing documentation f ## 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: [http://msdn.microsoft.com/en-us/magazine/cc302121.aspx](http://msdn.microsoft.com/en-us/magazine/cc302121.aspx). +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](https://docs.microsoft.com/en-us/dotnet/csharp/programming-guide/xmldoc/xml-documentation-comments). A violation of this rule occurs if an element containing parameters is missing documentation for one or more of its parameters. diff --git a/documentation/SA1612.md b/documentation/SA1612.md index c346fb714..fa4f2a4f5 100644 --- a/documentation/SA1612.md +++ b/documentation/SA1612.md @@ -21,7 +21,7 @@ The documentation describing the parameters to a C# method, constructor, delegat ## 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: [http://msdn.microsoft.com/en-us/magazine/cc302121.aspx](http://msdn.microsoft.com/en-us/magazine/cc302121.aspx). +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](https://docs.microsoft.com/en-us/dotnet/csharp/programming-guide/xmldoc/xml-documentation-comments). A violation of this rule occurs if the documentation for an element's parameters does not match the actual parameters on the element, or if the parameter documentation is not listed in the same order as the element's parameters. diff --git a/documentation/SA1613.md b/documentation/SA1613.md index 8ef8055da..be44fbf8c 100644 --- a/documentation/SA1613.md +++ b/documentation/SA1613.md @@ -21,7 +21,7 @@ A `` tag within a C# element's documentation header is missing a name att ## 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: [http://msdn.microsoft.com/en-us/magazine/cc302121.aspx](http://msdn.microsoft.com/en-us/magazine/cc302121.aspx). +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](https://docs.microsoft.com/en-us/dotnet/csharp/programming-guide/xmldoc/xml-documentation-comments). A violation of this rule occurs if the documentation for an element contains a `` tag which is missing a name attribute, or which contains an empty name attribute. diff --git a/documentation/SA1614.md b/documentation/SA1614.md index 3b819441d..4d1515e12 100644 --- a/documentation/SA1614.md +++ b/documentation/SA1614.md @@ -21,7 +21,7 @@ A `` tag within a C# element's documentation header is empty. ## 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: [http://msdn.microsoft.com/en-us/magazine/cc302121.aspx](http://msdn.microsoft.com/en-us/magazine/cc302121.aspx). +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](https://docs.microsoft.com/en-us/dotnet/csharp/programming-guide/xmldoc/xml-documentation-comments). A violation of this rule occurs if the documentation for an element contains a `` tag which is empty and does not contain a description of the parameter. diff --git a/documentation/SA1615.md b/documentation/SA1615.md index 2cc4f8e70..46d7f327e 100644 --- a/documentation/SA1615.md +++ b/documentation/SA1615.md @@ -21,7 +21,7 @@ A C# element is missing documentation for its return value. ## 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: [http://msdn.microsoft.com/en-us/magazine/cc302121.aspx](http://msdn.microsoft.com/en-us/magazine/cc302121.aspx). +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](https://docs.microsoft.com/en-us/dotnet/csharp/programming-guide/xmldoc/xml-documentation-comments). A violation of this rule occurs if an element containing a return value is missing a `` tag. diff --git a/documentation/SA1616.md b/documentation/SA1616.md index 37f329af2..3b1075c7e 100644 --- a/documentation/SA1616.md +++ b/documentation/SA1616.md @@ -21,7 +21,7 @@ The `` tag within a C# element's documentation header is empty. ## 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: [http://msdn.microsoft.com/en-us/magazine/cc302121.aspx](http://msdn.microsoft.com/en-us/magazine/cc302121.aspx). +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](https://docs.microsoft.com/en-us/dotnet/csharp/programming-guide/xmldoc/xml-documentation-comments). A violation of this rule occurs if an element contains an empty `` tag. diff --git a/documentation/SA1617.md b/documentation/SA1617.md index 2ebc8a697..d2483a528 100644 --- a/documentation/SA1617.md +++ b/documentation/SA1617.md @@ -21,7 +21,7 @@ A C# code element does not contain a return value, or returns void, but the docu ## 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: [http://msdn.microsoft.com/en-us/magazine/cc302121.aspx](http://msdn.microsoft.com/en-us/magazine/cc302121.aspx). +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](https://docs.microsoft.com/en-us/dotnet/csharp/programming-guide/xmldoc/xml-documentation-comments). A violation of this rule occurs if an element which returns void contains a `` tag within its documentation header. diff --git a/documentation/SA1618.md b/documentation/SA1618.md index 5541af19c..5071d3475 100644 --- a/documentation/SA1618.md +++ b/documentation/SA1618.md @@ -21,7 +21,7 @@ A generic C# element is missing documentation for one or more of its generic typ ## 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: [http://msdn.microsoft.com/en-us/magazine/cc302121.aspx](http://msdn.microsoft.com/en-us/magazine/cc302121.aspx). +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](https://docs.microsoft.com/en-us/dotnet/csharp/programming-guide/xmldoc/xml-documentation-comments). A violation of this rule occurs if an element containing generic type parameters is missing documentation for one or more of its generic type parameters. diff --git a/documentation/SA1619.md b/documentation/SA1619.md index e103bd2f1..87009694a 100644 --- a/documentation/SA1619.md +++ b/documentation/SA1619.md @@ -21,7 +21,7 @@ A generic, partial C# element is missing documentation for one or more of its ge ## 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: [http://msdn.microsoft.com/en-us/magazine/cc302121.aspx](http://msdn.microsoft.com/en-us/magazine/cc302121.aspx). +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](https://docs.microsoft.com/en-us/dotnet/csharp/programming-guide/xmldoc/xml-documentation-comments). A violation of this rule occurs when a generic, partial element is missing documentation for one or more of its generic type parameters, and the documentation for the element contains a `` tag rather than a `` tag. diff --git a/documentation/SA1620.md b/documentation/SA1620.md index 77dfa6b73..bc3360bce 100644 --- a/documentation/SA1620.md +++ b/documentation/SA1620.md @@ -21,7 +21,7 @@ The `` tags within the Xml header documentation for a generic C# elem ## 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: [http://msdn.microsoft.com/en-us/magazine/cc302121.aspx](http://msdn.microsoft.com/en-us/magazine/cc302121.aspx). +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](https://docs.microsoft.com/en-us/dotnet/csharp/programming-guide/xmldoc/xml-documentation-comments). A violation of this rule occurs if the `` tags within the element's header documentation do not match the generic type parameters on the element, or do not appear in the same order as the element's type parameters. diff --git a/documentation/SA1621.md b/documentation/SA1621.md index 335e2ffc7..b6987aace 100644 --- a/documentation/SA1621.md +++ b/documentation/SA1621.md @@ -21,7 +21,7 @@ A `` tag within the Xml header documentation for a generic C# element ## 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: [http://msdn.microsoft.com/en-us/magazine/cc302121.aspx](http://msdn.microsoft.com/en-us/magazine/cc302121.aspx). +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](https://docs.microsoft.com/en-us/dotnet/csharp/programming-guide/xmldoc/xml-documentation-comments). A violation of this rule occurs if the element contains a `` tag within its Xml header documentation which does not declare the name of the type parameter. diff --git a/documentation/SA1622.md b/documentation/SA1622.md index 09ef394e7..f7f88f957 100644 --- a/documentation/SA1622.md +++ b/documentation/SA1622.md @@ -21,7 +21,7 @@ A `` tag within the Xml header documentation for a generic C# element ## 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: [http://msdn.microsoft.com/en-us/magazine/cc302121.aspx](http://msdn.microsoft.com/en-us/magazine/cc302121.aspx). +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](https://docs.microsoft.com/en-us/dotnet/csharp/programming-guide/xmldoc/xml-documentation-comments). A violation of this rule occurs if the element contains an empty `` tag within its Xml header documentation. diff --git a/documentation/SA1623.md b/documentation/SA1623.md index e1870deeb..08bab4932 100644 --- a/documentation/SA1623.md +++ b/documentation/SA1623.md @@ -21,7 +21,7 @@ The documentation text within a C# property's `` tag does not match the ## 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:[http://msdn.microsoft.com/en-us/magazine/cc302121.aspx](http://msdn.microsoft.com/en-us/magazine/cc302121.aspx). +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](https://docs.microsoft.com/en-us/dotnet/csharp/programming-guide/xmldoc/xml-documentation-comments). A violation of this rule occurs if a property's summary documentation does not match the accessors within the property. diff --git a/documentation/SA1624.md b/documentation/SA1624.md index 22698250f..51e429c21 100644 --- a/documentation/SA1624.md +++ b/documentation/SA1624.md @@ -21,7 +21,7 @@ The documentation text within a C# property's `` tag takes into account ## 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: [http://msdn.microsoft.com/en-us/magazine/cc302121.aspx](http://msdn.microsoft.com/en-us/magazine/cc302121.aspx). +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](https://docs.microsoft.com/en-us/dotnet/csharp/programming-guide/xmldoc/xml-documentation-comments). A violation of this rule occurs when one of the accessors within the property has limited access (usually the set accessor), but the summary documentation text for the property still refers to both accessors. diff --git a/documentation/SA1625.md b/documentation/SA1625.md index cc77e0163..03c0777ae 100644 --- a/documentation/SA1625.md +++ b/documentation/SA1625.md @@ -21,7 +21,7 @@ The Xml documentation for a C# element contains two or more identical entries, i ## 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: [http://msdn.microsoft.com/en-us/magazine/cc302121.aspx](http://msdn.microsoft.com/en-us/magazine/cc302121.aspx). +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](https://docs.microsoft.com/en-us/dotnet/csharp/programming-guide/xmldoc/xml-documentation-comments). A violation of this rule occurs when an element contains two or more identical documentation texts. For example: diff --git a/documentation/SA1627.md b/documentation/SA1627.md index ad8d1b146..b474895a1 100644 --- a/documentation/SA1627.md +++ b/documentation/SA1627.md @@ -21,7 +21,7 @@ The Xml header documentation for a C# code element contains an empty tag. ## 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: [http://msdn.microsoft.com/en-us/magazine/cc302121.aspx](http://msdn.microsoft.com/en-us/magazine/cc302121.aspx). +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](https://docs.microsoft.com/en-us/dotnet/csharp/programming-guide/xmldoc/xml-documentation-comments). A violation of this rule occurs when the documentation header for an element contains an empty tag. For example: diff --git a/documentation/SA1628.md b/documentation/SA1628.md index 32ebbbc78..41aa20d2c 100644 --- a/documentation/SA1628.md +++ b/documentation/SA1628.md @@ -24,7 +24,7 @@ A section of the Xml header documentation for a C# element does not begin with a ## 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: [http://msdn.microsoft.com/en-us/magazine/cc302121.aspx](http://msdn.microsoft.com/en-us/magazine/cc302121.aspx). +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](https://docs.microsoft.com/en-us/dotnet/csharp/programming-guide/xmldoc/xml-documentation-comments). A violation of this rule occurs when part of the documentation does not begin with a capital letter. For example, the summary text in the documentation below begins with a lower-case letter: diff --git a/documentation/SA1629.md b/documentation/SA1629.md index 88b02086f..b71bf12c9 100644 --- a/documentation/SA1629.md +++ b/documentation/SA1629.md @@ -21,7 +21,7 @@ A section of the Xml header documentation for a C# element does not end with a p ## 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: [http://msdn.microsoft.com/en-us/magazine/cc302121.aspx](http://msdn.microsoft.com/en-us/magazine/cc302121.aspx). +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](https://docs.microsoft.com/en-us/dotnet/csharp/programming-guide/xmldoc/xml-documentation-comments). A violation of this rule occurs when part of the documentation does not end with a period. For example, the summary text in the documentation below does not end with a period: diff --git a/documentation/SA1630.md b/documentation/SA1630.md index 411dfbdbc..a840fb90f 100644 --- a/documentation/SA1630.md +++ b/documentation/SA1630.md @@ -24,7 +24,7 @@ A section of the Xml header documentation for a C# element does not contain any ## 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: [http://msdn.microsoft.com/en-us/magazine/cc302121.aspx](http://msdn.microsoft.com/en-us/magazine/cc302121.aspx). +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](https://docs.microsoft.com/en-us/dotnet/csharp/programming-guide/xmldoc/xml-documentation-comments). A violation of this rule occurs when part of the documentation does contain any whitespace between words. This can indicate poorly written or poorly formatted documentation. For example: diff --git a/documentation/SA1631.md b/documentation/SA1631.md index 67e07a4e6..e22043047 100644 --- a/documentation/SA1631.md +++ b/documentation/SA1631.md @@ -24,7 +24,7 @@ A section of the Xml header documentation for a C# element does not contain enou ## 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: [http://msdn.microsoft.com/en-us/magazine/cc302121.aspx](http://msdn.microsoft.com/en-us/magazine/cc302121.aspx). +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](https://docs.microsoft.com/en-us/dotnet/csharp/programming-guide/xmldoc/xml-documentation-comments). A violation of this rule occurs when part of the documentation does contain enough characters. This rule is calculated by counting the number of alphabetic characters and numbers within the documentation text, and comparing it against the number of symbols and other non-alphabetic characters. If the percentage of non-alphabetic characters is too high, this generally indicates poorly formatted documentation which will be difficult to read. For example, consider the follow summary documentation: diff --git a/documentation/SA1632.md b/documentation/SA1632.md index d1227cc08..cabe4ea75 100644 --- a/documentation/SA1632.md +++ b/documentation/SA1632.md @@ -26,7 +26,7 @@ A section of the Xml header documentation for a C# element is too short. ## 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: [http://msdn.microsoft.com/en-us/magazine/cc302121.aspx](http://msdn.microsoft.com/en-us/magazine/cc302121.aspx). +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](https://docs.microsoft.com/en-us/dotnet/csharp/programming-guide/xmldoc/xml-documentation-comments). A violation of this rule occurs when part of the documentation is too short. This can often indicate that the documentation is not descriptive. For example: diff --git a/documentation/SA1642.md b/documentation/SA1642.md index fd854bd1b..f64ea96b4 100644 --- a/documentation/SA1642.md +++ b/documentation/SA1642.md @@ -23,7 +23,7 @@ The XML documentation header for a C# constructor does not contain the appropria 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: [http://msdn.microsoft.com/en-us/magazine/cc302121.aspx](http://msdn.microsoft.com/en-us/magazine/cc302121.aspx). +following article: [https://docs.microsoft.com/en-us/dotnet/csharp/programming-guide/xmldoc/xml-documentation-comments](https://docs.microsoft.com/en-us/dotnet/csharp/programming-guide/xmldoc/xml-documentation-comments). A violation of this rule occurs when the summary tag within the documentation header for a constructor does not begin with the proper text. diff --git a/documentation/SA1643.md b/documentation/SA1643.md index 5eaa9e65b..7ca871791 100644 --- a/documentation/SA1643.md +++ b/documentation/SA1643.md @@ -21,7 +21,7 @@ The Xml documentation header for a C# finalizer does not contain the appropriate ## 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: [http://msdn.microsoft.com/en-us/magazine/cc302121.aspx](http://msdn.microsoft.com/en-us/magazine/cc302121.aspx). +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](https://docs.microsoft.com/en-us/dotnet/csharp/programming-guide/xmldoc/xml-documentation-comments). A violation of this rule occurs when the summary tag within the documentation header for a finalizer does not begin with the proper text. diff --git a/documentation/SA1644.md b/documentation/SA1644.md index 474aa6bf5..6fb46b142 100644 --- a/documentation/SA1644.md +++ b/documentation/SA1644.md @@ -21,7 +21,7 @@ A section within the Xml documentation header for a C# element contains blank li ## 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: [http://msdn.microsoft.com/en-us/magazine/cc302121.aspx](http://msdn.microsoft.com/en-us/magazine/cc302121.aspx). +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](https://docs.microsoft.com/en-us/dotnet/csharp/programming-guide/xmldoc/xml-documentation-comments). A violation of this rule occurs when the documentation header contains one or more blank lines within a section of documentation. For example: diff --git a/documentation/SA1645.md b/documentation/SA1645.md index 55b8c4978..38371bc8a 100644 --- a/documentation/SA1645.md +++ b/documentation/SA1645.md @@ -24,7 +24,7 @@ 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: [http://msdn.microsoft.com/en-us/magazine/cc302121.aspx.](http://msdn.microsoft.com/en-us/magazine/cc302121.aspx) +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.](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: diff --git a/documentation/SA1646.md b/documentation/SA1646.md index 9cc0546b7..fc1ecc4fa 100644 --- a/documentation/SA1646.md +++ b/documentation/SA1646.md @@ -24,7 +24,7 @@ An included Xml documentation link contains an invalid path. ## 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: [http://msdn.microsoft.com/en-us/magazine/cc302121.aspx.](http://msdn.microsoft.com/en-us/magazine/cc302121.aspx) +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.](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: diff --git a/documentation/SA1647.md b/documentation/SA1647.md index 493408eec..4b698dfd8 100644 --- a/documentation/SA1647.md +++ b/documentation/SA1647.md @@ -24,7 +24,7 @@ An include tag within an Xml documentation header does not contain valid file an ## 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: [http://msdn.microsoft.com/en-us/magazine/cc302121.aspx.](http://msdn.microsoft.com/en-us/magazine/cc302121.aspx) +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.](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: