Skip to content

FSharpApiDoc

type FSharpApiDoc =
    {
        Summary: string option
        Remarks: string option
        Examples: string list
        Parameters: (string * string) list
        TypeParameters: (string * string) list
        Returns: string option
        Exceptions: (string * string) list
        Obsolete: string option
        SeeAlso: string list
    }
AssemblyNacara.Plugin.FSharpApi

Everything the XML documentation said about one declaration.

Fields

Summary: string option
Remarks: string option
Examples: string list

Examples, in the order they were written.

Parameters: (string * string) list
TypeParameters: (string * string) list

Type parameters the author documented, by name.

Returns: string option
Exceptions: (string * string) list

What it raises, and when.

Obsolete: string option
SeeAlso: string list

Properties

static member Empty: FSharpApiDoc