C# Class ImportComments.Rewriter

Inheritance: CSharpSyntaxRewriter

Show file Open project: dotnet/import-comments Class Usage Examples

Public Methods

Method	Description
GetDocCommentForId ( string id ) : string	Given a SyntaxNode for an API node, look up the doc comment and return it as a string.
Rewriter ( SemanticModel model, string>.Dictionary membersDictionary ) : System.Collections.Generic
VisitClassDeclaration ( ClassDeclarationSyntax node ) : SyntaxNode
VisitConstructorDeclaration ( ConstructorDeclarationSyntax node ) : SyntaxNode
VisitConversionOperatorDeclaration ( ConversionOperatorDeclarationSyntax node ) : SyntaxNode
VisitDelegateDeclaration ( DelegateDeclarationSyntax node ) : SyntaxNode
VisitDestructorDeclaration ( DestructorDeclarationSyntax node ) : SyntaxNode
VisitEnumDeclaration ( EnumDeclarationSyntax node ) : SyntaxNode
VisitEnumMemberDeclaration ( EnumMemberDeclarationSyntax node ) : SyntaxNode
VisitEventDeclaration ( EventDeclarationSyntax node ) : SyntaxNode
VisitEventFieldDeclaration ( EventFieldDeclarationSyntax node ) : SyntaxNode
VisitFieldDeclaration ( FieldDeclarationSyntax node ) : SyntaxNode
VisitIndexerDeclaration ( IndexerDeclarationSyntax node ) : SyntaxNode
VisitInterfaceDeclaration ( InterfaceDeclarationSyntax node ) : SyntaxNode
VisitMethodDeclaration ( MethodDeclarationSyntax node ) : SyntaxNode
VisitOperatorDeclaration ( OperatorDeclarationSyntax node ) : SyntaxNode
VisitPropertyDeclaration ( PropertyDeclarationSyntax node ) : SyntaxNode
VisitStructDeclaration ( StructDeclarationSyntax node ) : SyntaxNode

Private Methods

Method	Description
AppendFormat ( XmlReader reader, StringBuilder output, string tagName ) : void
AppendFormattedOutputWithAttributes ( XmlReader reader, StringBuilder output, string tagName, string attributeTypeName ) : void
AppendPrettyPrintedComment ( XmlReader reader, StringBuilder output ) : void
ApplyDocComment ( Microsoft.CodeAnalysis.SyntaxNode node, string docCommentId ) : Microsoft.CodeAnalysis.SyntaxNode
IsPrivateOrInternal ( Accessibility enumValue ) : bool
IsShortEnough ( string s, int upperBound ) : bool

Method Details

GetDocCommentForId() public method

Given a SyntaxNode for an API node, look up the doc comment and return it as a string.

public GetDocCommentForId ( string id ) : string
id	string	CommentID for the API
return	string

Rewriter() public method

public Rewriter ( SemanticModel model, string>.Dictionary membersDictionary ) : System.Collections.Generic
model	SemanticModel
membersDictionary	string>.Dictionary
return	System.Collections.Generic

VisitClassDeclaration() public method

public VisitClassDeclaration ( ClassDeclarationSyntax node ) : SyntaxNode
node	ClassDeclarationSyntax
return	SyntaxNode

VisitConstructorDeclaration() public method

public VisitConstructorDeclaration ( ConstructorDeclarationSyntax node ) : SyntaxNode
node	ConstructorDeclarationSyntax
return	SyntaxNode

VisitConversionOperatorDeclaration() public method

public VisitConversionOperatorDeclaration ( ConversionOperatorDeclarationSyntax node ) : SyntaxNode
node	ConversionOperatorDeclarationSyntax
return	SyntaxNode

VisitDelegateDeclaration() public method

public VisitDelegateDeclaration ( DelegateDeclarationSyntax node ) : SyntaxNode
node	DelegateDeclarationSyntax
return	SyntaxNode

VisitDestructorDeclaration() public method

public VisitDestructorDeclaration ( DestructorDeclarationSyntax node ) : SyntaxNode
node	DestructorDeclarationSyntax
return	SyntaxNode

VisitEnumDeclaration() public method

public VisitEnumDeclaration ( EnumDeclarationSyntax node ) : SyntaxNode
node	EnumDeclarationSyntax
return	SyntaxNode

VisitEnumMemberDeclaration() public method

public VisitEnumMemberDeclaration ( EnumMemberDeclarationSyntax node ) : SyntaxNode
node	EnumMemberDeclarationSyntax
return	SyntaxNode

VisitEventDeclaration() public method

public VisitEventDeclaration ( EventDeclarationSyntax node ) : SyntaxNode
node	EventDeclarationSyntax
return	SyntaxNode

VisitEventFieldDeclaration() public method

public VisitEventFieldDeclaration ( EventFieldDeclarationSyntax node ) : SyntaxNode
node	EventFieldDeclarationSyntax
return	SyntaxNode

VisitFieldDeclaration() public method

public VisitFieldDeclaration ( FieldDeclarationSyntax node ) : SyntaxNode
node	FieldDeclarationSyntax
return	SyntaxNode

VisitIndexerDeclaration() public method

public VisitIndexerDeclaration ( IndexerDeclarationSyntax node ) : SyntaxNode
node	IndexerDeclarationSyntax
return	SyntaxNode

VisitInterfaceDeclaration() public method

public VisitInterfaceDeclaration ( InterfaceDeclarationSyntax node ) : SyntaxNode
node	InterfaceDeclarationSyntax
return	SyntaxNode

VisitMethodDeclaration() public method

public VisitMethodDeclaration ( MethodDeclarationSyntax node ) : SyntaxNode
node	MethodDeclarationSyntax
return	SyntaxNode

VisitOperatorDeclaration() public method

public VisitOperatorDeclaration ( OperatorDeclarationSyntax node ) : SyntaxNode
node	OperatorDeclarationSyntax
return	SyntaxNode

VisitPropertyDeclaration() public method

public VisitPropertyDeclaration ( PropertyDeclarationSyntax node ) : SyntaxNode
node	PropertyDeclarationSyntax
return	SyntaxNode

VisitStructDeclaration() public method

public VisitStructDeclaration ( StructDeclarationSyntax node ) : SyntaxNode
node	StructDeclarationSyntax
return	SyntaxNode