MCPcopy Create free account
hub / github.com/Effect-TS/effect / parseModuleJSDocTs

Function parseModuleJSDocTs

packages/tools/jsdocs/src/Jsdocs.ts:3243–3257  ·  view source on GitHub ↗
(
  sourceFile: ts.SourceFile,
  moduleJSDoc: ParsedModuleJSDoc,
  diagnostics: Array<JSDocModelDiagnostic>,
  linkContext: { readonly checker: ts.TypeChecker; readonly entry: ProgramCacheEntry; readonly cwd: string }
)

Source from the content-addressed store, hash-verified

3241}
3242
3243function parseModuleJSDocTs(
3244 sourceFile: ts.SourceFile,
3245 moduleJSDoc: ParsedModuleJSDoc,
3246 diagnostics: Array<JSDocModelDiagnostic>,
3247 linkContext: { readonly checker: ts.TypeChecker; readonly entry: ProgramCacheEntry; readonly cwd: string }
3248): ParsedModuleJSDoc | undefined {
3249 const block = parseLooseJSDocBlock(moduleJSDoc.raw, [moduleJSDoc.range[0], moduleJSDoc.range[1]])
3250 if (block.internal) return undefined
3251 const tags = buildTags("module", block.tags)
3252 if (tags._tag === "Failure") addModelDiagnostics(diagnostics, block.range, tags.error.diagnostics)
3253 const examples = parseModuleExamples(block)
3254 addModelDiagnostics(diagnostics, block.range, examples.diagnostics)
3255 addJSDocLinkDiagnostics(sourceFile, block, diagnostics, linkContext)
3256 return moduleJSDoc
3257}
3258
3259function parseSourceFileDocs(
3260 cwd: string,

Callers 1

parseSourceFileDocsFunction · 0.85

Calls 5

parseLooseJSDocBlockFunction · 0.85
buildTagsFunction · 0.85
addModelDiagnosticsFunction · 0.85
parseModuleExamplesFunction · 0.85
addJSDocLinkDiagnosticsFunction · 0.85

Tested by

no test coverage detected