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

Function parseDoc

packages/tools/docgen/src/Parser.ts:103–115  ·  view source on GitHub ↗
(text: string)

Source from the content-addressed store, hash-verified

101): u is ast.VariableStatement => u.getKind() === ast.ts.SyntaxKind.VariableStatement
102
103const parseDoc = (text: string) => {
104 const comment = parseComment(text)
105 return new Domain.Doc(
106 comment.description,
107 comment.tags["since"] ?? [],
108 comment.tags["deprecated"] ?? [],
109 comment.tags["example"] ?? [],
110 comment.tags["category"] ?? [],
111 comment.tags["throws"] ?? [],
112 comment.tags["see"] ?? [],
113 comment.tags
114 )
115}
116
117const shouldIgnore = (doc: Domain.Doc): boolean => {
118 return Record.has(doc.tags, "internal") || Record.has(doc.tags, "ignore")

Callers 13

parseTypeFunction · 0.85
parseFunctionDeclarationFunction · 0.85
parseExportSpecifierFunction · 0.85
parseExportStarFunction · 0.85
parseModuleDeclarationFunction · 0.85
parseMethodFunction · 0.85
parsePropertyFunction · 0.85
parseClassFunction · 0.85

Calls 1

parseCommentFunction · 0.85

Tested by

no test coverage detected