FSharp.Formatting


FSharp.Formatting.ApiDocs Namespace

Functionality relating to generating API documentation

Type Description

ApiDocAttribute

Represents a custom attribute attached to source code

ApiDocCollection

Represents a group of assemblies integrated with its associated documentation

ApiDocComment

Represents a documentation comment attached to source code

ApiDocEntity

Represents a type definition integrated with its associated documentation

ApiDocEntityInfo

High-level information about a module definition

ApiDocFileExtensions

ApiDocHtml

Represents some HTML formatted by model generation

ApiDocInput

Represents an input assembly for API doc generation

ApiDocMember

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

ApiDocMemberDetails

ApiDocMemberKind

Represents the kind of member

ApiDocModel

Represents a set of assemblies integrated with their associated documentation

ApiDocNamespace

Represents a namespace integrated with its associated documentation

ApiDocs

This type exposes the functionality for producing documentation model from `dll` files with associated `xml` files generated by the F# or C# compiler. To generate documentation model, use one of the overloades of the `Generate` method.

ApiDocsSearchIndexEntry

Represents an entry suitable for constructing a Lunr index