Skip to content

FSharpApiOptions

type FSharpApiOptions =
    {
        Sources: FSharpApiSource list
        Root: string
        Title: string
        Exclude: string list
        WarnOnUndocumented: bool
    }
AssemblyNacara.Plugin.FSharpApi

Options of the F# API reference plugin.

Fields

Sources: FSharpApiSource list
Root: string

Route prefix the pages are published under.

Title: string

Title of the page that lists the namespaces.

Exclude: string list

Namespaces to leave out, with everything under them.

A namespace F# has to make public for the library to compile, but that no reader should be sent to - My.Library.Internal and its like.

WarnOnUndocumented: bool

Report a member that takes parameters and documents none of them.

Off by default. On, it is a warning per member, which check turns into a failure.