ApiDocComment (FSharp.Formatting)

ApiDocComment Type

Namespace: FSharp.Formatting.ApiDocs
Assembly: FSharp.Formatting.ApiDocs.dll
Base Type: obj

Represents a documentation comment attached to source code

Constructors

Constructor Description

Constructor	Description
`ApiDocComment(xmldoc, summary, remarks, parameters, returns, examples, notes, exceptions, seeAlso, rawData)` Full Usage: `ApiDocComment(xmldoc, summary, remarks, parameters, returns, examples, notes, exceptions, seeAlso, rawData)` Parameters: xmldoc : `XElement option` summary : `ApiDocHtml` remarks : `ApiDocHtml option` parameters : `(string * ApiDocHtml) list` returns : `ApiDocHtml option` examples : `ApiDocHtml list` notes : `ApiDocHtml list` exceptions : `(string * string option * ApiDocHtml) list` seeAlso : `(string * string option * ApiDocHtml) list` rawData : `KeyValuePair<string, string> list` Returns: `ApiDocComment`	xmldoc : `XElement option` summary : `ApiDocHtml` remarks : `ApiDocHtml option` parameters : `(string * ApiDocHtml) list` returns : `ApiDocHtml option` examples : `ApiDocHtml list` notes : `ApiDocHtml list` exceptions : `(string * string option * ApiDocHtml) list` seeAlso : `(string * string option * ApiDocHtml) list` rawData : `KeyValuePair<string, string> list` Returns: `ApiDocComment`


                
                  
                    
                      ApiDocComment(xmldoc, summary, remarks, parameters, returns, examples, notes, exceptions, seeAlso, rawData)

Full Usage: ApiDocComment(xmldoc, summary, remarks, parameters, returns, examples, notes, exceptions, seeAlso, rawData)

Parameters:

xmldoc : XElement option

summary : ApiDocHtml

remarks : ApiDocHtml option

parameters : (string * ApiDocHtml) list

returns : ApiDocHtml option

examples : ApiDocHtml list

notes : ApiDocHtml list

exceptions : (string * string option * ApiDocHtml) list

seeAlso : (string * string option * ApiDocHtml) list

rawData : KeyValuePair<string, string> list

Returns: ApiDocComment

xmldoc : XElement option
summary : ApiDocHtml
remarks : ApiDocHtml option
parameters : (string * ApiDocHtml) list
returns : ApiDocHtml option
examples : ApiDocHtml list
notes : ApiDocHtml list
exceptions : (string * string option * ApiDocHtml) list
seeAlso : (string * string option * ApiDocHtml) list
rawData : KeyValuePair<string, string> list

Returns: ApiDocComment

Instance members

Instance member	Description
`this.Examples` Full Usage: `this.Examples` Returns: `ApiDocHtml list`	The examples sections of the comment Returns: `ApiDocHtml list`
`this.Exceptions` Full Usage: `this.Exceptions` Returns: `(string * string option * ApiDocHtml) list`	The notes sections of the comment Returns: `(string * string option * ApiDocHtml) list`
`this.Notes` Full Usage: `this.Notes` Returns: `ApiDocHtml list`	The notes sections of the comment Returns: `ApiDocHtml list`
`this.Parameters` Full Usage: `this.Parameters` Returns: `(string * ApiDocHtml) list`	The param sections of the comment Returns: `(string * ApiDocHtml) list`
`this.RawData` Full Usage: `this.RawData` Returns: `KeyValuePair<string, string> list`	The raw data of the comment Returns: `KeyValuePair<string, string> list`
`this.Remarks` Full Usage: `this.Remarks` Returns: `ApiDocHtml option`	The remarks html for comment Returns: `ApiDocHtml option`
`this.Returns` Full Usage: `this.Returns` Returns: `ApiDocHtml option`	The return sections of the comment Returns: `ApiDocHtml option`
`this.SeeAlso` Full Usage: `this.SeeAlso` Returns: `(string * string option * ApiDocHtml) list`	The top-level "seealso" sections of the comment, rendered as a "See also:" list Returns: `(string * string option * ApiDocHtml) list`
`this.Summary` Full Usage: `this.Summary` Returns: `ApiDocHtml`	The summary for the comment Returns: `ApiDocHtml`
`this.Xml` Full Usage: `this.Xml` Returns: `XElement option`	The XElement for the XML doc if available Returns: `XElement option`