Method getTsDocCommentsForFunction

scripts/docs/lib/comments.ts:82–113

(node: ts.Node, sourceFile: ts.SourceFile)

  }

  static getTsDocCommentsForFunction(node: ts.Node, sourceFile: ts.SourceFile) {
    const params: Record<string, string> = {};
    const trivia =
      ts.getLeadingCommentRanges(sourceFile.text, node.getFullStart()) || [];

    let comment = "";

    for (const range of trivia) {
      const commentText = Comments.removeCommentSyntax(
        sourceFile.text.substring(range.pos, range.end),
      );

      const lines = commentText.split("\n").map((line) => line.trim());

      if (lines.length && !lines[0].startsWith("@param")) {
        comment = lines[0];
      }

      lines.forEach((line) => {
        if (line.startsWith("@param")) {
          const parts = line.split(/\s+/);
          if (parts.length >= 3) {
            const paramName = parts[1];
            const description = parts.slice(2).join(" ");
            params[paramName] = description.trim();
          }
        }
      });
    }

    return { comment, params };
  }
}