Skip to content

Commit

Permalink
Replaced / removed obsolete MSDN magazine URL
Browse files Browse the repository at this point in the history
  • Loading branch information
vweijsters committed Jun 27, 2017
1 parent 000b45d commit ae50c00
Show file tree
Hide file tree
Showing 71 changed files with 71 additions and 169 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,7 @@ namespace StyleCop.Analyzers.DocumentationRules
/// </summary>
/// <remarks>
/// <para>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:
/// <see href="http://msdn.microsoft.com/en-us/magazine/cc302121.aspx"/>.</para>
/// code, through the use of Xml documentation headers.</para>
///
/// <para>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,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,10 +18,7 @@ namespace StyleCop.Analyzers.DocumentationRules
/// </summary>
/// <remarks>
/// <para>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:
/// <see href="http://msdn.microsoft.com/en-us/magazine/cc302121.aspx">XML Comments Let You Build Documentation
/// Directly From Your Visual Studio .NET Source Files</see>.</para>
/// code, through the use of XML documentation headers.</para>
///
/// <para>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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,10 +17,7 @@ namespace StyleCop.Analyzers.DocumentationRules
/// </summary>
/// <remarks>
/// <para>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:
/// <see href="http://msdn.microsoft.com/en-us/magazine/cc302121.aspx">XML Comments Let You Build Documentation
/// Directly From Your Visual Studio .NET Source Files</see>.</para>
/// code, through the use of XML documentation headers.</para>
///
/// <para>A violation of this rule occurs when an item within an enumeration is missing a header. For
/// example:</para>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,10 +13,7 @@ namespace StyleCop.Analyzers.DocumentationRules
/// </summary>
/// <remarks>
/// <para>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:
/// <see href="http://msdn.microsoft.com/en-us/magazine/cc302121.aspx">XML Comments Let You Build Documentation
/// Directly From Your Visual Studio .NET Source Files</see>.</para>
/// code, through the use of XML documentation headers.</para>
///
/// <para>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.</para>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,10 +17,7 @@ namespace StyleCop.Analyzers.DocumentationRules
/// </summary>
/// <remarks>
/// <para>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:
/// <see href="http://msdn.microsoft.com/en-us/magazine/cc302121.aspx">XML Comments Let You Build Documentation
/// Directly From Your Visual Studio .NET Source Files</see>.</para>
/// code, through the use of XML documentation headers.</para>
///
/// <para>A violation of this rule occurs when the element documentation is missing a <c>&lt;summary&gt;</c>
/// tag.</para>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,10 +17,7 @@ namespace StyleCop.Analyzers.DocumentationRules
/// </summary>
/// <remarks>
/// <para>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:
/// <see href="http://msdn.microsoft.com/en-us/magazine/cc302121.aspx">XML Comments Let You Build Documentation
/// Directly From Your Visual Studio .NET Source Files</see>.</para>
/// code, through the use of XML documentation headers.</para>
///
/// <para>A violation of this rule occurs when the documentation header for a partial element (an element with the
/// partial attribute) is missing a <c>&lt;summary&gt;</c> or <c>&lt;content&gt;</c> tag, or contains an empty
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,10 +16,7 @@ namespace StyleCop.Analyzers.DocumentationRules
/// </summary>
/// <remarks>
/// <para>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:
/// <see href="http://msdn.microsoft.com/en-us/magazine/cc302121.aspx">XML Comments Let You Build Documentation
/// Directly From Your Visual Studio .NET Source Files</see>.</para>
/// code, through the use of XML documentation headers.</para>
///
/// <para>A violation of this rule occurs when the documentation header for an element contains an empty
/// <c>&lt;summary&gt;</c> tag which does not contain a description of the element.</para>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,10 +17,7 @@ namespace StyleCop.Analyzers.DocumentationRules
/// </summary>
/// <remarks>
/// <para>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:
/// <see href="http://msdn.microsoft.com/en-us/magazine/cc302121.aspx">XML Comments Let You Build Documentation
/// Directly From Your Visual Studio .NET Source Files</see>.</para>
/// code, through the use of XML documentation headers.</para>
///
/// <para>A violation of this rule occurs when the documentation header for a partial element (an element with the
/// partial attribute) contains an empty <c>&lt;summary&gt;</c> tag or <c>&lt;content&gt;</c> tag which does not
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,10 +19,7 @@ namespace StyleCop.Analyzers.DocumentationRules
/// </summary>
/// <remarks>
/// <para>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:
/// <see href="http://msdn.microsoft.com/en-us/magazine/cc302121.aspx">XML Comments Let You Build Documentation
/// Directly From Your Visual Studio .NET Source Files</see>.</para>
/// code, through the use of XML documentation headers.</para>
///
/// <para>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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,10 +16,7 @@ namespace StyleCop.Analyzers.DocumentationRules
/// </summary>
/// <remarks>
/// <para>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:
/// <see href="http://msdn.microsoft.com/en-us/magazine/cc302121.aspx">XML Comments Let You Build Documentation
/// Directly From Your Visual Studio .NET Source Files</see>.</para>
/// code, through the use of XML documentation headers.</para>
///
/// <para>The documentation for properties may include a <c>&lt;value&gt;</c> tag, which describes the value held by
/// the property.</para>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,10 +16,7 @@ namespace StyleCop.Analyzers.DocumentationRules
/// </summary>
/// <remarks>
/// <para>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:
/// <see href="http://msdn.microsoft.com/en-us/magazine/cc302121.aspx">XML Comments Let You Build Documentation
/// Directly From Your Visual Studio .NET Source Files</see>.</para>
/// code, through the use of XML documentation headers.</para>
///
/// <para>The documentation for properties may include a <c>&lt;value&gt;</c> tag, which describes the value held by
/// the property.</para>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,10 +18,7 @@ namespace StyleCop.Analyzers.DocumentationRules
/// </summary>
/// <remarks>
/// <para>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:
/// <see href="http://msdn.microsoft.com/en-us/magazine/cc302121.aspx">XML Comments Let You Build Documentation
/// Directly From Your Visual Studio .NET Source Files</see>.</para>
/// code, through the use of XML documentation headers.</para>
///
/// <para>A violation of this rule occurs if an element containing parameters is missing documentation for one or
/// more of its parameters.</para>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,10 +18,7 @@ namespace StyleCop.Analyzers.DocumentationRules
/// </summary>
/// <remarks>
/// <para>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:
/// <see href="http://msdn.microsoft.com/en-us/magazine/cc302121.aspx">XML Comments Let You Build Documentation
/// Directly From Your Visual Studio .NET Source Files</see>.</para>
/// code, through the use of XML documentation headers.</para>
///
/// <para>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.</para>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,10 +18,7 @@ namespace StyleCop.Analyzers.DocumentationRules
/// </summary>
/// <remarks>
/// <para>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:
/// <see href="http://msdn.microsoft.com/en-us/magazine/cc302121.aspx">XML Comments Let You Build Documentation
/// Directly From Your Visual Studio .NET Source Files</see>.</para>
/// code, through the use of XML documentation headers.</para>
///
/// <para>A violation of this rule occurs if the documentation for an element contains a <c>&lt;param&gt;</c> tag
/// which is missing a <c>name</c> attribute, or which contains an empty <c>name</c> attribute.</para>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,10 +17,7 @@ namespace StyleCop.Analyzers.DocumentationRules
/// </summary>
/// <remarks>
/// <para>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:
/// <see href="http://msdn.microsoft.com/en-us/magazine/cc302121.aspx">XML Comments Let You Build Documentation
/// Directly From Your Visual Studio .NET Source Files</see>.</para>
/// code, through the use of XML documentation headers.</para>
///
/// <para>A violation of this rule occurs if the documentation for an element contains a <c>&lt;param&gt;</c> tag
/// which is empty and does not contain a description of the parameter.</para>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,10 +19,7 @@ namespace StyleCop.Analyzers.DocumentationRules
/// </summary>
/// <remarks>
/// <para>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:
/// <see href="http://msdn.microsoft.com/en-us/magazine/cc302121.aspx">XML Comments Let You Build Documentation
/// Directly From Your Visual Studio .NET Source Files</see>.</para>
/// code, through the use of XML documentation headers.</para>
///
/// <para>A violation of this rule occurs if an element containing a return value is missing a
/// <c>&lt;returns&gt;</c> tag.</para>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,10 +17,7 @@ namespace StyleCop.Analyzers.DocumentationRules
/// </summary>
/// <remarks>
/// <para>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:
/// <see href="http://msdn.microsoft.com/en-us/magazine/cc302121.aspx">XML Comments Let You Build Documentation
/// Directly From Your Visual Studio .NET Source Files</see>.</para>
/// code, through the use of XML documentation headers.</para>
///
/// <para>A violation of this rule occurs if an element contains an empty <c>&lt;returns&gt;</c> tag.</para>
/// </remarks>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,10 +19,7 @@ namespace StyleCop.Analyzers.DocumentationRules
/// </summary>
/// <remarks>
/// <para>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:
/// <see href="http://msdn.microsoft.com/en-us/magazine/cc302121.aspx">XML Comments Let You Build Documentation
/// Directly From Your Visual Studio .NET Source Files</see>.</para>
/// code, through the use of XML documentation headers.</para>
///
/// <para>A violation of this rule occurs if an element which returns <c>void</c> contains a <c>&lt;returns&gt;</c>
/// tag within its documentation header.</para>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,10 +19,7 @@ namespace StyleCop.Analyzers.DocumentationRules
/// </summary>
/// <remarks>
/// <para>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:
/// <see href="http://msdn.microsoft.com/en-us/magazine/cc302121.aspx">XML Comments Let You Build Documentation
/// Directly From Your Visual Studio .NET Source Files</see>.</para>
/// code, through the use of XML documentation headers.</para>
///
/// <para>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.</para>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,10 +20,7 @@ namespace StyleCop.Analyzers.DocumentationRules
/// </summary>
/// <remarks>
/// <para>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:
/// <see href="http://msdn.microsoft.com/en-us/magazine/cc302121.aspx">XML Comments Let You Build Documentation
/// Directly From Your Visual Studio .NET Source Files</see>.</para>
/// code, through the use of XML documentation headers.</para>
///
/// <para>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 <c>&lt;summary&gt;</c> tag
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,10 +22,7 @@ namespace StyleCop.Analyzers.DocumentationRules
/// </summary>
/// <remarks>
/// <para>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:
/// <see href="http://msdn.microsoft.com/en-us/magazine/cc302121.aspx">XML Comments Let You Build Documentation
/// Directly From Your Visual Studio .NET Source Files</see>.</para>
/// code, through the use of XML documentation headers.</para>
///
/// <para>A violation of this rule occurs when an element contains two or more identical documentation texts. For
/// example:</para>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,10 +18,7 @@ namespace StyleCop.Analyzers.DocumentationRules
/// </summary>
/// <remarks>
/// <para>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:
/// <see href="http://msdn.microsoft.com/en-us/magazine/cc302121.aspx">XML Comments Let You Build Documentation
/// Directly From Your Visual Studio .NET Source Files</see>.</para>
/// code, through the use of XML documentation headers.</para>
///
/// <para>A violation of this rule occurs when the documentation header for an element contains an empty tag. For
/// example:</para>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,10 +15,7 @@ namespace StyleCop.Analyzers.DocumentationRules
/// <para>This diagnostic is not implemented in StyleCopAnalyzers.</para>
///
/// <para>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:
/// <see href="http://msdn.microsoft.com/en-us/magazine/cc302121.aspx">XML Comments Let You Build Documentation
/// Directly From Your Visual Studio .NET Source Files</see>.</para>
/// code, through the use of XML documentation headers.</para>
///
/// <para>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:</para>
Expand Down
Loading

0 comments on commit ae50c00

Please sign in to comment.