Header menu logo fantomas

XmlDocCollector Type

Used to collect XML documentation during lexing and parsing.

Constructors

Constructor Description

XmlDocCollector()

Full Usage: XmlDocCollector()

Returns: XmlDocCollector

Create a fresh XmlDocCollector

Returns: XmlDocCollector

Instance members

Instance member Description

this.AddGrabPoint

Full Usage: this.AddGrabPoint

Parameters:

Add a point where prior XmlDoc are collected

pos : pos

this.AddGrabPointDelayed

Full Usage: this.AddGrabPointDelayed

Parameters:

Indicate the next XmlDoc will act as a point where prior XmlDoc are collected

pos : pos

this.AddXmlDocLine

Full Usage: this.AddXmlDocLine

Parameters:
    line : string
    range : range

Add a line of XmlDoc text

line : string
range : range

this.CheckInvalidXmlDocPositions

Full Usage: this.CheckInvalidXmlDocPositions

Returns: range list

Check if XmlDoc comments are at invalid positions, and if so report them

Returns: range list

this.HasComments

Full Usage: this.HasComments

Parameters:
    grabPointPos : pos

Returns: bool

Indicates it the given point has XmlDoc comments

grabPointPos : pos
Returns: bool

this.LinesBefore

Full Usage: this.LinesBefore

Parameters:
    grabPointPos : pos

Returns: (string * range)[]

Get the documentation lines before the given point

grabPointPos : pos
Returns: (string * range)[]

Type something to start searching.