Skip to content

Update: JSDoc documentation for A11y (fixes #829)#830

Merged
oliverfoster merged 17 commits intomasterfrom
issue/829
Apr 13, 2026
Merged

Update: JSDoc documentation for A11y (fixes #829)#830
oliverfoster merged 17 commits intomasterfrom
issue/829

Conversation

@kirsty-hames
Copy link
Copy Markdown
Contributor

@kirsty-hames kirsty-hames commented Feb 18, 2026 •
edited
Loading

Update

  • Fixes JSDocs - A11y #829
  • Adds JSDoc documentation comments to core a11y files:
    • Includes file-level documentation explaining architecture and usage patterns
    • Documents public methods with parameter types, return values, and examples
  • Update ariaDisabled.js @Class for consistency with the filename and module purpose

Testing

  1. Open any of the following files in VS Code or another JSDoc-compatible editor:
  • a11y.js
  • a11y/ariaDisabled.js
  • a11y/browserConfig.js
  • a11y/browserFocus.js
  • a11y/deprecated.js
  • a11y/focusOptions.js
  • a11y/keyboardFocusOutline.js
  • a11y/log.js
  • a11y/popup.js
  • a11y/scroll.js
  • a11y/topOfContentObject.js
  • a11y/wrapFocus.js
  • fixes/safari.label.click.blur.js
  1. Hover over a method name (e.g., a11y.focusFirst) to see the tooltip documentation
  2. When calling a method, verify autocomplete suggests parameters with type information

@kirsty-hames kirsty-hames moved this from New to Needs Reviewing in adapt_framework: The TODO Board Feb 18, 2026
@kirsty-hames kirsty-hames self-assigned this Feb 18, 2026
@oliverfoster oliverfoster merged commit 6b84475 into master Apr 13, 2026
1 check passed
@oliverfoster oliverfoster deleted the issue/829 branch April 13, 2026 10:11
@github-project-automation github-project-automation Bot moved this from Needs Reviewing to Recently Released in adapt_framework: The TODO Board Apr 13, 2026
github-actions Bot pushed a commit that referenced this pull request Apr 13, 2026
@semantic-release-bot
Chore(release): 6.77.0
13bd2b9 
# [6.77.0](v6.76.0...v6.77.0) (2026-04-13)

### Update

* JSDoc documentation for A11y (fixes #829) (#830) ([6b84475](6b84475)), closes [#829](#829) [#830](#830)
@oliverfoster
Copy link
Copy Markdown
Member

oliverfoster commented Apr 13, 2026

🎉 This PR is included in version 6.77.0 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

@kirsty-hames kirsty-hames

Labels

documentation released

Projects

adapt_framework: The TODO Board
Status: Recently Released

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

JSDocs - A11y

2 participants

@kirsty-hames @oliverfoster