FSharpApiSource
type FSharpApiSource =
{
Path: string
SearchPaths: string list
}| Assembly | Nacara.Plugin.FSharpApi |
An assembly to document, and where its dependencies are.
Fields
Functions and values
create (path: string) : FSharpApiSource
create (path: string) : FSharpApiSourceAn assembly to document.
| Parameter | |
|---|---|
path | Where 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
searchPaths (paths: string list) (source: FSharpApiSource) : FSharpApiSourceWhere else to look for what the assembly references.
| Parameter | |
|---|---|
paths | Directories holding its dependencies. Beside the assembly, the running runtime and the site's own directory are searched without being asked. |
source | The assembly being described. |