DocumentationCommentId Class

Definition

APIs for constructing documentation comment id's, and finding symbols that match ids.

public ref class DocumentationCommentId abstract sealed
public static class DocumentationCommentId
type DocumentationCommentId = class
Public Class DocumentationCommentId
Inheritance
DocumentationCommentId

Methods

CreateDeclarationId(ISymbol)

Creates an id string used by external documentation comment files to identify declarations of types, namespaces, methods, properties, etc.

CreateReferenceId(ISymbol)

Creates an id string used to reference type symbols (not strictly declarations, includes arrays, pointers, type parameters, etc.)

GetFirstSymbolForDeclarationId(String, Compilation)

Gets the first declaration symbol that matches the declaration id string, order undefined.

GetFirstSymbolForReferenceId(String, Compilation)

Gets the first symbol that matches the reference id string, order undefined.

GetSymbolsForDeclarationId(String, Compilation)

Gets all declaration symbols that match the declaration id string

GetSymbolsForReferenceId(String, Compilation)

Gets the symbols that match the reference id string.

Applies to