Update: Add JSDoc documentation to content model hierarchy (fixes #852)#862
Open
joe-replin wants to merge 1 commit into
Open
Update: Add JSDoc documentation to content model hierarchy (fixes #852)#862joe-replin wants to merge 1 commit into
joe-replin wants to merge 1 commit into
Conversation
Add comprehensive JSDoc comments to core model files and the mpabc controller to improve inline docs and API clarity. Files updated: articleModel, blockModel, componentModel, contentObjectModel, courseModel, menuModel, pageModel and mpabc.js. Class- and file-level descriptions were added (including relationships in the Adapt content hierarchy, attempt state notes for components, and a brief example for mpabc). Also documents MenuModel.setCustomLocking. These are documentation-only changes and do not alter runtime behavior.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Fixes #852
Update
courseModel.js— Added@file,@module, and@classdocumentation describing its role as the top-level course root nodecontentObjectModel.js— Added module and class documentation for the shared base of pages and menuspageModel.js— Added module and class documentation, clarifying that pages are leaf-level content objects containing articlesmenuModel.js— Added module and class documentation; added JSDoc forsetCustomLocking()describing its recursive locking behaviourarticleModel.js— Added module and class documentation for the article tier of the content hierarchyblockModel.js— Added module and class documentation for the block tiercomponentModel.js— Added module and class documentation, including a description of the compact attempt-state array format[numbers[], booleans[], arrays[]]used for SCORM trackingmpabc.js— Added module and class documentation for the MPABC bootstrap controller, including a side-effects import example and description of theAdapt.contentObjects / articles / blocks / componentscollections it createsTesting
/**blocks)grunt devand verify no build errors are introduced by the documentation additions