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 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Full Usage:
this.Category
Returns: string
|
|
Full Usage:
this.CategoryIndex
Returns: int
|
|
|
|
|
|
|
|
Full Usage:
this.Exclude
Returns: bool
|
|
|
|
Full Usage:
this.IsObsolete
Returns: bool
|
|
Full Usage:
this.IsTypeDefinition
Returns: bool
|
|
Full Usage:
this.Name
Returns: string
|
|
|
|
Full Usage:
this.ObsoleteMessage
Returns: string
|
|
Full Usage:
this.OutputFile
Parameters:
string
qualify : bool
extension : string
Returns: string
|
|
|
|
Full Usage:
this.RequiresQualifiedAccess
Returns: bool
|
|
Full Usage:
this.SourceLocation
Returns: string option
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Full Usage:
this.Url
Parameters:
string
collectionName : string
qualify : bool
extension : string
Returns: string
|
|
Full Usage:
this.UrlBaseName
Returns: string
|
|
|
|
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
|