ApiDocMember (FSharp.Formatting)

ApiDocMember Type

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

Represents an method, property, constructor, function or value, record field, union case or static parameter integrated with its associated documentation. Includes extension members.

Constructors

Constructor Description

Constructor	Description
`ApiDocMember(displayName, attributes, entityUrlBaseName, kind, cat, catidx, exclude, details, comment, symbol, warn)` Full Usage: `ApiDocMember(displayName, attributes, entityUrlBaseName, kind, cat, catidx, exclude, details, comment, symbol, warn)` Parameters: displayName : `string` attributes : `ApiDocAttribute list` entityUrlBaseName : `string` kind : `ApiDocMemberKind` cat : `string` catidx : `int` exclude : `bool` details : `ApiDocMemberDetails` comment : `ApiDocComment` symbol : `FSharpSymbol` warn : `bool` Returns: `ApiDocMember`	displayName : `string` attributes : `ApiDocAttribute list` entityUrlBaseName : `string` kind : `ApiDocMemberKind` cat : `string` catidx : `int` exclude : `bool` details : `ApiDocMemberDetails` comment : `ApiDocComment` symbol : `FSharpSymbol` warn : `bool` Returns: `ApiDocMember`


                
                  
                    
                      ApiDocMember(displayName, attributes, entityUrlBaseName, kind, cat, catidx, exclude, details, comment, symbol, warn)

Full Usage: ApiDocMember(displayName, attributes, entityUrlBaseName, kind, cat, catidx, exclude, details, comment, symbol, warn)

Parameters:

displayName : string

attributes : ApiDocAttribute list

entityUrlBaseName : string

kind : ApiDocMemberKind

cat : string

catidx : int

exclude : bool

details : ApiDocMemberDetails

comment : ApiDocComment

symbol : FSharpSymbol

warn : bool

Returns: ApiDocMember

displayName : string
attributes : ApiDocAttribute list
entityUrlBaseName : string
kind : ApiDocMemberKind
cat : string
catidx : int
exclude : bool
details : ApiDocMemberDetails
comment : ApiDocComment
symbol : FSharpSymbol
warn : bool

Returns: ApiDocMember

Instance members

Instance member	Description
`this.Attributes` Full Usage: `this.Attributes` Returns: `ApiDocAttribute list`	The declared attributes of the member Returns: `ApiDocAttribute list`
`this.Category` Full Usage: `this.Category` Returns: `string`	The category Returns: `string`
`this.CategoryIndex` Full Usage: `this.CategoryIndex` Returns: `int`	The category index Returns: `int`
`this.Comment` Full Usage: `this.Comment` Returns: `ApiDocComment`	The attached comment Returns: `ApiDocComment`
`this.CompiledName` Full Usage: `this.CompiledName` Returns: `string option`	The member's compiled name, if any Returns: `string option`
`this.CustomOperationName` Full Usage: `this.CustomOperationName` Returns: `string option`	Returns the custom operation name, when this attribute is the CustomOperationAttribute. Returns: `string option`
`this.Details` Full Usage: `this.Details` Returns: `ApiDocMemberDetails`	The members details Returns: `ApiDocMemberDetails`
`this.Exclude` Full Usage: `this.Exclude` Returns: `bool`	The exclude flag Returns: `bool`
`this.ExtendedType` Full Usage: `this.ExtendedType` Returns: `(FSharpEntity * ApiDocHtml) option`	The type extended by an extension member, if any Returns: `(FSharpEntity * ApiDocHtml) option`
`this.FormatCompiledName` Full Usage: `this.FormatCompiledName` Returns: `string`	Formats the compiled name Returns: `string`
`this.FormatModifiers` Full Usage: `this.FormatModifiers` Returns: `string`	Formats modifiers Returns: `string`
`this.FormatTypeArguments` Full Usage: `this.FormatTypeArguments` Returns: `string option`	Formats type arguments Returns: `string option`
`this.IsObsolete` Full Usage: `this.IsObsolete` Returns: `bool`	Gets a value indicating whether this member is obsolete Returns: `bool`
`this.IsRequireQualifiedAccessAttribute` Full Usage: `this.IsRequireQualifiedAccessAttribute` Returns: `bool`	Returns: `bool`
`this.Kind` Full Usage: `this.Kind` Returns: `ApiDocMemberKind`	The kind of the member Returns: `ApiDocMemberKind`
`this.Modifiers` Full Usage: `this.Modifiers` Returns: `string list`	The member's modifiers Returns: `string list`
`this.Name` Full Usage: `this.Name` Returns: `string`	Name of the member Returns: `string`
`this.ObsoleteMessage` Full Usage: `this.ObsoleteMessage` Returns: `string`	Returns the obsolete message, when this member is obsolete. When its not or no message was specified, an empty string is returned Returns: `string`
`this.Parameters` Full Usage: `this.Parameters` Returns: `(type) list`	The member's parameters and associated documentation Returns: `(type) list`
`this.ReturnInfo` Full Usage: `this.ReturnInfo` Returns: `(type)`	The return section in a typical tooltip Returns: `(type)`
`this.SourceLocation` Full Usage: `this.SourceLocation` Returns: `string option`	The URL of the member's source location, if any Returns: `string option`
`this.Symbol` Full Usage: `this.Symbol` Returns: `FSharpSymbol`	The symbol this member is related to Returns: `FSharpSymbol`
`this.TypeArguments` Full Usage: `this.TypeArguments` Returns: `string list`	The member's type arguments Returns: `string list`
`this.Url` Full Usage: `this.Url` Parameters: root : `string` collectionName : `string` qualify : `bool` extension : `string` Returns: `string`	The URL of the best link documentation for the item relative to "reference" directory (without the http://site.io/reference) root : `string` collectionName : `string` qualify : `bool` extension : `string` Returns: `string`
`this.UrlBaseName` Full Usage: `this.UrlBaseName` Returns: `string`	The URL base name of the best link documentation for the item (without the http://site.io/reference) Returns: `string`
`this.UsageHtml` Full Usage: `this.UsageHtml` Returns: `ApiDocHtml`	The usage section in a typical tooltip Returns: `ApiDocHtml`

Static members

Static member	Description
`ApiDocMember.GetUrl(entityUrlBaseName, displayName, root, collectionName, qualify, extension)` Full Usage: `ApiDocMember.GetUrl(entityUrlBaseName, displayName, root, collectionName, qualify, extension)` Parameters: entityUrlBaseName : `string` displayName : `string` root : `string` collectionName : `string` qualify : `bool` extension : `string` Returns: `string`	The URL of the best link documentation for the item relative to "reference" directory (without the http://site.io/reference) entityUrlBaseName : `string` displayName : `string` root : `string` collectionName : `string` qualify : `bool` extension : `string` Returns: `string`