Table of Contents

Method GetDescription

Namespace
Alternet.Syntax.CodeCompletion
Assembly
Alternet.Syntax.v9.dll

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

Obtains description of some language element.

public virtual 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 described language element.

fullDescription bool

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

Returns

string

GetDescription(IListMembers, ISyntaxNode, object, string, bool, out string, out int, out int, out Image)

protected virtual string GetDescription(IListMembers members, ISyntaxNode node, object member, string name, bool fullDescription, out string memberName, out int memberType, out int imageIndex, out Image image)

Parameters

members IListMembers
node ISyntaxNode
member object
name string
fullDescription bool
memberName string
memberType int
imageIndex int
image Image

Returns

string