Update: Add JSDoc documentation to core view classes (fixes #854)#864
Open
joe-replin wants to merge 1 commit into
Open
Update: Add JSDoc documentation to core view classes (fixes #854)#864joe-replin wants to merge 1 commit into
joe-replin wants to merge 1 commit into
Conversation
Add comprehensive JSDoc comments and method documentation to multiple view classes to improve IDE hints and developer understanding. Updates include file/module/class-level descriptions, @class/@classdesc annotations, param/returns/throws tags, @fires and @deprecated notices, and clarifications for lifecycle and question APIs. Files changed: js/views/articleView.js, js/views/blockView.js, js/views/componentView.js, js/views/contentObjectView.js, js/views/menuItemView.js, js/views/menuView.js, js/views/pageView.js, js/views/questionView.js. These are documentation-only changes and do not alter runtime behaviour.
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 #854
Update
@file,@module, and@class/@classdesc/@extendsblock tocontentObjectView.js, including@firestags for all lifecycle events and full JSDoc forrender(),remove(), andrenderTo()@file,@module, and@classblock topageView.js; documentedremove()override explaining$pageLabelcleanup@file,@module, and@classblock tomenuView.js@file,@module, and@classblock tomenuItemView.js@file,@module, and@classblock toarticleView.js@file,@module, and@classblock toblockView.js@file,@module, and@classblock tocomponentView.js; added@returns {void}tosetupInviewCompletion()@file,@module, and@classblock toquestionView.jswith full documentation of the submit pipeline, feedback, reset, and correct-answer reveal methods; documented all@protectedoverride hooks and all@deprecatedcompatibility-layer methods with@returnstypes and{@link}cross-referencesTesting
grunt devand confirm no build errors are introduced by the JSDoc changes@paramtypes, and@deprecatedwarnings on the compatibility-layer methodslog.deprecated()runtime calls remain intact inquestionView.jsby opening a course in the browser, triggering a legacy question component, and verifying the deprecation warnings appear in the console