Header menu logo FSharp.Formatting

ApiDocEntityInfo Type

High-level information about a module definition

Constructors

Constructor Description

ApiDocEntityInfo(entity, collection, ns, parent)

Full Usage: ApiDocEntityInfo(entity, collection, ns, parent)

Parameters:
Returns: ApiDocEntityInfo
entity : ApiDocEntity
collection : ApiDocCollection
ns : ApiDocNamespace
parent : ApiDocEntity option
Returns: ApiDocEntityInfo

Instance members

Instance member Description

this.Collection

Full Usage: this.Collection

Returns: ApiDocCollection

The collection of assemblies the entity belongs to

Returns: ApiDocCollection

this.Entity

Full Usage: this.Entity

Returns: ApiDocEntity

The actual entity

Returns: ApiDocEntity

this.Namespace

Full Usage: this.Namespace

Returns: ApiDocNamespace

The namespace the entity belongs to

Returns: ApiDocNamespace

this.ParentModule

Full Usage: this.ParentModule

Returns: ApiDocEntity option

The parent module, if any.

Returns: ApiDocEntity option

Type something to start searching.