Skip to content

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

Open
joe-replin wants to merge 7 commits intomasterfrom
issue/827
Open

Update: JSDoc documentation for core entry points (fixes #827)#828
joe-replin wants to merge 7 commits intomasterfrom
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

@joe-replin joe-replin self-assigned this Feb 4, 2026
@joe-replin joe-replin moved this from New to Needs Reviewing in adapt_framework: The TODO Board Feb 4, 2026
@joe-replin joe-replin linked an issue Feb 4, 2026 that may be closed by this pull request
12 tasks
Comment thread js/adapt.js
Comment on lines +39 to +40
* **Important:** Many properties have been moved to dedicated services.
* Use `import service from 'core/js/service'` instead of `Adapt.service`.
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* **Important:** Many properties have been moved to dedicated services.
* Use `import service from 'core/js/service'` instead of `Adapt.service`.
* **Important:** Many properties have been moved to dedicated modules.
* Use `import module from 'core/js/module'` instead of `Adapt.module`.

@oliverfoster oliverfoster moved this from Needs Reviewing to Assigned in adapt_framework: The TODO Board Apr 13, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

Development

Successfully merging this pull request may close these issues.

JSDocs - Core Entry Points Add JSDoc Documentation to Core Framework

2 participants