Skip to content

FSharpApiSource

type FSharpApiSource =
    {
        Path: string
        SearchPaths: string list
    }
AssemblyNacara.Plugin.FSharpApi

An assembly to document, and where its dependencies are.

Fields

Path: string

Path of the assembly, relative to the project root.

SearchPaths: string list

Extra directories to look in for its dependencies.

Functions and values

create (path: string) : FSharpApiSource

An assembly to document.

Parameter
pathWhere it is, relative to the project root - or absolute, which is how a site points at the directory it is itself running from.
searchPaths (paths: string list) (source: FSharpApiSource) : FSharpApiSource

Where else to look for what the assembly references.

Parameter
pathsDirectories holding its dependencies. Beside the assembly, the running runtime and the site's own directory are searched without being asked.
sourceThe assembly being described.