FSharp.Formatting
ApiDocEntity Type
Represents a type definition integrated with its associated documentation
Constructors
| Constructor |
Description
|
Full Usage:
ApiDocEntity(tdef, name, cat, catidx, exclude, urlBaseName, comment, assembly, attributes, cases, fields, statParams, ctors, inst, stat, allInterfaces, baseType, abbreviatedType, delegateSignature, symbol, nested, vals, exts, pats, rqa, location, substitutions)
Parameters:
bool
name : string
cat : string
catidx : int
exclude : bool
urlBaseName : string
comment : ApiDocComment
assembly : AssemblyName
attributes : ApiDocAttribute list
cases : ApiDocMember list
fields : ApiDocMember list
statParams : ApiDocMember list
ctors : ApiDocMember list
inst : ApiDocMember list
stat : ApiDocMember list
allInterfaces : (FSharpType * ApiDocHtml) list
baseType : (FSharpType * ApiDocHtml) option
abbreviatedType : (FSharpType * ApiDocHtml) option
delegateSignature : (FSharpDelegateSignature * ApiDocHtml) option
symbol : FSharpEntity
nested : ApiDocEntity list
vals : ApiDocMember list
exts : ApiDocMember list
pats : ApiDocMember list
rqa : bool
location : string option
substitutions : Substitutions
Returns: ApiDocEntity
|
|
Instance members
| Instance member |
Description
|
|
If this is a type abbreviation, then the abbreviated type
|
|
Active patterns of the module
|
|
All interfaces of the type, formatted
|
|
All members of the type
|
|
The name of the type's assembly
|
|
The declared attributes of the type
|
|
The base type of the type, formatted
|
Full Usage:
this.Category
Returns: string
|
The category of the type
|
Full Usage:
this.CategoryIndex
Returns: int
|
The category index of the type
|
|
The attached comment
|
|
The constuctorsof the type
|
|
If this is a delegate, then e formatted signature
|
Full Usage:
this.Exclude
Returns: bool
|
The exclude flag
|
|
The instance members of the type
|
Full Usage:
this.IsObsolete
Returns: bool
|
Gets a value indicating whether this member is obsolete
|
Full Usage:
this.IsTypeDefinition
Returns: bool
|
Indicates if the entity is a type definition
|
Full Usage:
this.Name
Returns: string
|
The name of the entity
|
|
All nested modules and types
|
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
|
Full Usage:
this.OutputFile
Parameters:
string
qualify : bool
extension : string
Returns: string
|
The name of the file generated for this entity
|
|
The fields of a record type
|
Full Usage:
this.RequiresQualifiedAccess
Returns: bool
|
Does the module have the RequiresQualifiedAccess attribute
|
Full Usage:
this.SourceLocation
Returns: string option
|
The URL of the member's source location, if any
|
|
The static members of the type
|
|
Static parameters
|
|
The substitution parameters active for generating thist content
|
|
The F# compiler symbol for the type definition
|
|
Type extensions of the module
|
|
The cases of a union type
|
Full Usage:
this.Url
Parameters:
string
collectionName : string
qualify : bool
extension : string
Returns: string
|
The URL of the best link for the entity relative to "reference" directory (without the http://site.io/reference)
|
Full Usage:
this.UrlBaseName
Returns: string
|
The URL base name of the primary documentation for the entity (without the http://site.io/reference)
|
|
Values and functions of the module
|
Static members
| Static member |
Description
|
Full Usage:
ApiDocEntity.GetUrl(urlBaseName, root, collectionName, qualify, extension)
Parameters:
string
root : string
collectionName : string
qualify : bool
extension : string
Returns: string
|
Compute the URL of the best link for the entity relative to "reference" directory (without the http://site.io/reference)
|