Skip to content

Update: JSDoc documentation for core entry points (fixes #827)#828

Open
joe-replin wants to merge 8 commits into
masterfrom
issue/827
Open

Update: JSDoc documentation for core entry points (fixes #827)#828
joe-replin wants to merge 8 commits into
masterfrom
issue/827

Conversation

@joe-replin
Copy link
Copy Markdown
Contributor

Update

  • Fixes JSDocs - Core Entry Points #827
  • Adds JSDoc documentation comments to six core framework files
  • Documents all public methods with parameter types, return values, and examples
  • Includes file-level documentation explaining architecture and usage patterns

Testing

  1. Open any of the following files in VS Code or another JSDoc-compatible editor:
    • adapt.js
    • app.js
    • components.js
    • data.js
    • router.js
    • startController.js
  2. Hover over a method name (e.g., router.navigateToElement) to see the tooltip documentation
  3. When calling a method, verify autocomplete suggests parameters with type information

Comment thread js/adapt.js Outdated
@oliverfoster oliverfoster moved this from Needs Reviewing to Assigned in adapt_framework: The TODO Board Apr 13, 2026
Co-authored-by: Oliver Foster <7974663+oliverfoster@users.noreply.github.com>
@joe-replin joe-replin requested a review from oliverfoster May 12, 2026 17:57
@joe-replin joe-replin moved this from Assigned to Needs Reviewing in adapt_framework: The TODO Board May 12, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

Status: Needs Reviewing

Development

Successfully merging this pull request may close these issues.

JSDocs - Core Entry Points Add JSDoc Documentation to Core Framework

2 participants