Skip to content

Add JSDoc Documentation to Core Framework #715

@joe-replin

Description

@joe-replin

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)

  • Base Classes: models/adaptModel.js, models/lockingModel.js, views/adaptView.js, collections/adaptCollection.js, collections/adaptSubsetCollection.js

3. Content Model Hierarchy (8 files)

  • Content Models: models/courseModel.js, models/contentObjectModel.js, models/pageModel.js, models/menuModel.js, models/articleModel.js, models/blockModel.js, models/componentModel.js, mpabc.js

4. Component Models (5 files)

  • Component Base Models: models/questionModel.js, models/itemModel.js, models/itemsComponentModel.js, models/itemsQuestionModel.js

5. Content Views (7 files)

  • Content Views: views/contentObjectView.js, views/pageView.js, views/menuView.js, views/menuItemView.js, views/articleView.js, views/blockView.js, views/componentView.js, views/questionView.js

6. Notification System (6 files) - #810

7. Navigation System (5 files)

  • Navigation: navigation.js, models/NavigationModel.js, models/NavigationButtonModel.js, views/navigationView.js, views/NavigationButtonView.js

8. Drawer System (3 files) - #812

  • Drawer: drawer.js, views/drawerView.js, views/drawerItemView.js

9. Accessibility System (12 files) - #829

  • A11y: 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

10. Template Systems (2 files)

  • Templates & Rendering: templates.js, reactHelpers.js

11. Tracking & State (3 files)

  • Tracking & Storage: tracking.js, offlineStorage.js, location.js

12. UI Component Systems (8 files)

  • UI Components: headings.js, views/headingView.js, views/buttonsView.js, tooltips.js, views/TooltipView.js, models/TooltipItemModel.js, shadow.js, views/ShadowView.js

13. Utilities & Helpers (8 files)

  • Utilities: helpers.js, modelHelpers.js, wait.js, device.js, logging.js, scrolling.js, DOMElementModifications.js, transitions.js

14. Compatibility & Fixes (7 files)

  • Compatibility Layer: deprecated.js, fixes.js, fixes/harden.js, fixes/img.lazyload.js, fixes/reactHelpers.html.js, fixes/safari.label.click.blur.js

Metadata

Metadata

Assignees

No one assigned

    Type

    Projects

    Status

    Recently Released

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions