Skip to content

Add JSDoc documentation to all exported symbols #70

@cablate

Description

@cablate

Overview

Exported tool definitions and handler functions currently lack JSDoc comments. Adding documentation improves maintainability and enables IDE tooling.

Proposed Work

  • Add JSDoc blocks to all exported constants in src/maps-tools/mapsTools.ts:
    • Document each tool's purpose, input schema fields (@param), and return shape (@returns)
  • Add JSDoc to any exported handler functions with @param, @returns, and @throws tags
  • Add an @example block for the most commonly used tools (search_nearby, get_place_details)
  • Optionally configure typedoc to generate an HTML docs site from the JSDoc

Acceptance Criteria

  • All exported symbols have at least a summary line, @param for each parameter, and @returns
  • No undocumented exports remain in src/maps-tools/

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions