Header menu logo F# Compiler Guide

XmlDoc Type

Represents collected XmlDoc lines

Constructors

Constructor Description

XmlDoc(unprocessedLines, range)

Full Usage: XmlDoc(unprocessedLines, range)

Parameters:
    unprocessedLines : string[]
    range : range

Returns: XmlDoc
unprocessedLines : string[]
range : range
Returns: XmlDoc

Instance members

Instance member Description

this.GetElaboratedXmlLines

Full Usage: this.GetElaboratedXmlLines

Returns: string[]

Get the lines after insertion of implicit summary tags and encoding

Returns: string[]

this.GetXmlText

Full Usage: this.GetXmlText

Returns: string

Get the elaborated XML documentation as XML text

Returns: string

this.IsEmpty

Full Usage: this.IsEmpty

Returns: bool

Indicates if the XmlDoc is empty

Returns: bool

this.NonEmpty

Full Usage: this.NonEmpty

Returns: bool

Indicates if the XmlDoc is non-empty

Returns: bool

this.Range

Full Usage: this.Range

Returns: range

Indicates the overall original source range of the XmlDoc

Returns: range

this.UnprocessedLines

Full Usage: this.UnprocessedLines

Returns: string[]

Get the lines before insertion of implicit summary tags and encoding

Returns: string[]

Static members

Static member Description

XmlDoc.Empty

Full Usage: XmlDoc.Empty

Returns: XmlDoc

Get the empty XmlDoc

Returns: XmlDoc

XmlDoc.Merge(doc1) (doc2)

Full Usage: XmlDoc.Merge(doc1) (doc2)

Parameters:
Returns: XmlDoc

Merge two XML documentation

doc1 : XmlDoc
doc2 : XmlDoc
Returns: XmlDoc

Type something to start searching.