Make fixes and improvements to PCUI's API reference docs #495
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.
This PR improves and corrects the JSDoc API reference documentation across multiple PCUI components.
Bug Fixes
EVENT_LINK_ELEMENTandEVENT_UNLINK_ELEMENTconstants that used:instead of=(TypeScript syntax error)precisionin JSDoc (was "2", should be "7")Documentation Improvements
Event Constants Added
Added properly documented static event constants with
@eventtags and usage examples to:EVENT_CHANGE,EVENT_SLIDER_MOUSEDOWN,EVENT_SLIDER_MOUSEUPEVENT_CHANGE,EVENT_FOCUS,EVENT_BLUREVENT_CHANGE,EVENT_FOCUS,EVENT_BLURMissing JSDoc Added
focus(),blur()methodsvalue,values,placeholder,renderChangespropertiesfocus(),blur()methods with parameter documentationvaluessettervaluegetter/setter,valuessettervaluegetter/setter,valuessetter,renderChangesgetter/setterfocus(),blur()methods,value,values,binding,placeholder,inputs,renderChangespropertiesfocus(),blur()methods,options,invalidOptions,disabledValue,disabledOptions,fallbackOrder,multiSelect,value,values,placeholder,renderChangesproperties