You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Add Comprehensive JSDoc Documentation to Core Framework
Description
This issue tracks the addition of comprehensive JSDoc documentation throughout the Adapt Framework Core (src/core/js) to improve code maintainability, developer experience, and enable automated API documentation generation.
Scope
All JavaScript modules in the core framework need to be documented with proper JSDoc markup.
Add Comprehensive JSDoc Documentation to Core Framework
Description
This issue tracks the addition of comprehensive JSDoc documentation throughout the Adapt Framework Core (
src/core/js) to improve code maintainability, developer experience, and enable automated API documentation generation.Scope
All JavaScript modules in the core framework need to be documented with proper JSDoc markup.
Core Modules to Document
1. Core Systems (6 files) - #827
2. Base Model/View/Collection Classes (5 files)
models/adaptModel.js,models/lockingModel.js,views/adaptView.js,collections/adaptCollection.js,collections/adaptSubsetCollection.js3. Content Model Hierarchy (8 files)
models/courseModel.js,models/contentObjectModel.js,models/pageModel.js,models/menuModel.js,models/articleModel.js,models/blockModel.js,models/componentModel.js,mpabc.js4. Component Models (5 files)
models/questionModel.js,models/itemModel.js,models/itemsComponentModel.js,models/itemsQuestionModel.js5. Content Views (7 files)
views/contentObjectView.js,views/pageView.js,views/menuView.js,views/menuItemView.js,views/articleView.js,views/blockView.js,views/componentView.js,views/questionView.js6. Notification System (6 files) - #810
7. Navigation System (5 files)
navigation.js,models/NavigationModel.js,models/NavigationButtonModel.js,views/navigationView.js,views/NavigationButtonView.js8. Drawer System (3 files) - #812
drawer.js,views/drawerView.js,views/drawerItemView.js9. Accessibility System (12 files) - #829
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.js10. Template Systems (2 files)
templates.js,reactHelpers.js11. Tracking & State (3 files)
tracking.js,offlineStorage.js,location.js12. UI Component Systems (8 files)
headings.js,views/headingView.js,views/buttonsView.js,tooltips.js,views/TooltipView.js,models/TooltipItemModel.js,shadow.js,views/ShadowView.js13. Utilities & Helpers (8 files)
helpers.js,modelHelpers.js,wait.js,device.js,logging.js,scrolling.js,DOMElementModifications.js,transitions.js14. Compatibility & Fixes (7 files)
deprecated.js,fixes.js,fixes/harden.js,fixes/img.lazyload.js,fixes/reactHelpers.html.js,fixes/safari.label.click.blur.js