SemanticExtractorModule

PackageFsLiveDocs.Runner
Converts compiler symbols immediately into renderer-neutral FsLiveDocs records.

Summary

NameSignatureSynopsis
extractBlockextractBlock contextHash range uses diagnosticsNo description available.
extractextract contextHash ranges checkResults mappedDiagnosticsNo description available.
artifactartifact resultsCreates a complete artifact only from successful compiler results.

extractBlock

extractBlock contextHash range uses diagnostics
Member

Parameters

NameTypeDescription
contextHashstring
rangeCompilationSourceRange
usesFSharpSymbolUse array
diagnosticsSemanticDiagnostic list

Returns

SemanticCodeBlock

extract

extract contextHash ranges checkResults mappedDiagnostics
Member

Parameters

NameTypeDescription
contextHashstring
rangesCompilationSourceRange list
checkResultsFSharpCheckFileResults
mappedDiagnosticsMappedCompilerDiagnostic list

Returns

SemanticCodeBlock list

artifact

artifact results
Member
Creates a complete artifact only from successful compiler results.

Parameters

NameTypeDescription
resultsCheckedCompilationUnit list

Returns

SemanticDocumentationArtifact