Update: Add JSDoc to core models, views, and collections (fixes #851)#861
Open
joe-replin wants to merge 1 commit into
Open
Update: Add JSDoc to core models, views, and collections (fixes #851)#861joe-replin wants to merge 1 commit into
joe-replin wants to merge 1 commit into
Conversation
Add comprehensive JSDoc file/class/method documentation across core modules: AdaptCollection, AdaptSubsetCollection, AdaptModel, LockingModel and AdaptView. Descriptions clarify responsibilities, public events, parameter/return types and internal behaviours (e.g. trackable state APIs, cooperative locking, JSX render pause/resume, child/parent caching and on-screen animation). Also make a small API clarification: AdaptModel.reset now has explicit defaults (type = 'hard', canReset = this.get('_canReset')). These changes are primarily documentation and developer-facing API clarification; no significant runtime logic changes are intended.
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
1 participant
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 #851
Update
@file,@class, and method-level JSDoc toadaptModel.js, covering hierarchy traversal, completion checking, trackable state, type group queries, locking, and relative navigationlockingModel.js, documenting the cooperative locking API (setLocking,unsetLocking,isLocking,getLockCount,setLockState)@file,@class, and method-level JSDoc toadaptView.js, covering rendering lifecycle, child view management, visibility toggling, and removal events@fileand@classJSDoc toadaptCollection.jsandadaptSubsetCollection.jsinitialize,defaults,attributes) to avoid over-documentationTesting
grunt devand confirm the build completes without errors