DocumentationCompilerModule
PackageFsLiveDocs.Runner
Evaluates the real MSBuild project and checks canonical documentation compilation units with FCS.
Summary
| Name | Signature | Synopsis |
|---|---|---|
| evaluateProjectFor | evaluateProjectFor targetFramework projectPath | Runs an inner-build ResolveReferences target so package, project, framework, and SDK references all come from MSBuild evaluation. |
| evaluateProject | evaluateProject projectPath | Evaluates the project's default documentation framework (the sole or first declared target). |
| checkUnit | checkUnit project unit | Checks one page or isolated unit. |
| checkBlocks | checkBlocks projectPath prelude blocks | No description available. |
| checkBlocksWithProject | checkBlocksWithProject project prelude blocks | No description available. |
Runs an inner-build ResolveReferences target so package, project, framework, and SDK references all come from MSBuild evaluation.
For a cross-targeting project, the first framework declared in TargetFrameworks is the documentation context.
Parameters
| Name | Type | Description |
|---|---|---|
| targetFramework | string option | |
| projectPath | string |
Returns
EvaluatedProject
Evaluates the project's default documentation framework (the sole or first declared target).
Parameters
| Name | Type | Description |
|---|---|---|
| projectPath | string |
Returns
EvaluatedProject
Checks one page or isolated unit. It never evaluates the resulting script.
Parameters
| Name | Type | Description |
|---|---|---|
| project | EvaluatedProject | |
| unit | CompilationUnit |
Returns
Async<CheckedCompilationUnit>
Parameters
| Name | Type | Description |
|---|---|---|
| projectPath | string | |
| prelude | string | |
| blocks | DocumentationBlock list |
Returns
Async<CheckedCompilationUnit list>