MCPcopy Create free account
hub / github.com/microsoft/typescript-go / handleGetDocumentationComment

Method handleGetDocumentationComment

internal/api/session.go:2688–2709  ·  view source on GitHub ↗

handleGetDocumentationComment returns the rendered documentation comment of a symbol as plain text.

(ctx context.Context, params *CheckerSymbolParams)

Source from the content-addressed store, hash-verified

2686
2687// handleGetDocumentationComment returns the rendered documentation comment of a symbol as plain text.
2688func (s *Session) handleGetDocumentationComment(ctx context.Context, params *CheckerSymbolParams) (string, error) {
2689 setup, err := s.setupChecker(ctx, params.Snapshot, params.Project)
2690 if err != nil {
2691 return "", err
2692 }
2693 defer setup.done()
2694
2695 symbol, err := setup.resolveSymbolHandle(params.Symbol)
2696 if err != nil {
2697 return "", err
2698 }
2699 if symbol == nil {
2700 return "", nil
2701 }
2702
2703 langSvc, err := s.setupLanguageService(setup.sd, setup.program, params.Project, "")
2704 if err != nil {
2705 return "", err
2706 }
2707
2708 return langSvc.GetSymbolDocumentationComment(setup.checker, symbol), nil
2709}
2710
2711// handleGetTypeArguments returns the type arguments of a type reference.
2712func (s *Session) handleGetTypeArguments(ctx context.Context, params *CheckerTypeParams) ([]*TypeResponse, error) {

Callers 1

HandleRequestMethod · 0.95

Calls 5

setupCheckerMethod · 0.95
setupLanguageServiceMethod · 0.95
doneMethod · 0.65
resolveSymbolHandleMethod · 0.45

Tested by

no test coverage detected