Skip to content

Latest commit

 

History

History
84 lines (72 loc) · 3.35 KB

HowToUpdateDocumentation.md

File metadata and controls

84 lines (72 loc) · 3.35 KB

How to: Update Documentation

The documentation in the following folders can be edited and updated:

/docs/*.md
/docs/cli/*.md

Documentation for project api in /docs/api is generated and should not be edited directly.

Documentation for analyzers and refactorings cannot be edited directly. It is generated from following metadata files:

To update documentation it is necessary to edit Analyzers.xml and/or Refactorings.xml and then run script MetadataGenerator.cmd to generate documentation.

Structure of Analyzers.xml

<?xml version="1.0" encoding="utf-8"?>
<Analyzers>
  <Analyzer Identifier="Identifier">
    <Id>RCSXXXX</Id>
    <Title>Title</Title>
    <MessageFormat>MessageFormat</MessageFormat> <!-- Message if often same as title. -->
    <Category>General</Category> <!-- See https://github.com/JosefPihrt/Roslynator/blob/master/src/Analyzers/DiagnosticCategories.cs -->
    <DefaultSeverity>Info</DefaultSeverity> <!-- Hidden, Info, Warning or Error -->
    <IsEnabledByDefault>true</IsEnabledByDefault>
    <SupportsFadeOut>false</SupportsFadeOut> <!-- true if analyzer will fade some tokens -->
    <SupportsFadeOutAnalyzer>false</SupportsFadeOutAnalyzer> <!-- if true, RCSXXXXFadeOut analyzer will be generated -->
    <MinLanguageVersion>0.0</MinLanguageVersion> <!-- optional section that specified minimal language version -->
    <Summary>Summary</Summary> <!-- optional section that contains raw markdown -->
    <Samples>
      <Sample>
        <Before><![CDATA[/* A code with diagnostic */ // [|Id|]]]></Before>
        <After><![CDATA[/* A code with fix */]]></After> <!-- omit this section if a diagnostic does not have a fix -->
      </Sample>
    </Samples>
    <Remarks>Remarks</Remarks> <!-- optional section that contains raw markdown -->
    <Links> <!-- optional links -->
      <Link>
        <Url>http://github.com/JosefPihrt/Roslynator</Url>
        <Text>A sample link</Text>
      </Link>
    </Links>
  </Analyzer>
</Analyzers>

Metadata sample above will produce RCSXXXX.md.

Structure of Refactorings.xml

<?xml version="1.0" encoding="utf-8"?>
<Refactorings>
  <Refactoring Id="RRXXXX" Identifier="Identifier" Title="Title" IsEnabledByDefault="false"> <!-- IsEnabledByDefault="true" can be omitted -->
    <Syntaxes>
      <Syntax>supported syntax (for example 'if statement')</Syntax>
    </Syntaxes>
    <Span>A span inside which a refactoring is supported (for example 'if keyword')</Span>
    <Summary>Summary</Summary> <!-- optional section that contains raw markdown -->
    <Samples>
      <Sample>
        <Before><![CDATA[/* A code before the refactoring is applied */]]></Before>
        <After><![CDATA[/* A code after the refactoring is applied */]]></After>
      </Sample>
    </Samples>
    <Remarks>Remarks</Remarks> <!-- optional section that contains raw markdown -->
    <Links> <!-- optional links -->
      <Link>
        <Url>http://github.com/JosefPihrt/Roslynator</Url>
        <Text>A sample link</Text>
      </Link>
    </Links>
  </Refactoring>
</Refactorings>

Metadata sample above will produce RRXXXX.md.