Method GetDescription

Namespace

Alternet.Syntax.CodeCompletion

Assembly

Alternet.Syntax.v10.dll

GetDescription(IListMembers, ISyntaxNode, object, string, bool)

When implemented by a class, obtains description of a language element.

string GetDescription(IListMembers members, ISyntaxNode node, object member, string name, bool fullDescription)

Parameters

members IListMembers

Specifies ListMembers interface used to get language-specific description.

node ISyntaxNode

Specifies ISyntaxNode that representing language element to describe.

member object

Specifies language element to describe.

name string

Specifies name of a language element.

fullDescription bool

Specifies whether description should include name and type of the found element.

Returns

string

String that describes specified language element.