docs: add JSDoc comments to E&A embed mode implementation #1931
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.
Related Ticket: #1929
Description of Changes
This PR adds comprehensive JSDoc documentation to the E&A (Explore and Analyze) embed mode implementation, as requested in issue #1929.
Files Updated:
atoms/embed.ts - Added file-level documentation and JSDoc comments for:
hydrateBooleanfunctiondehydrateBooleanfunctionisEmbeddedAtomexportatoms/center.ts - Added file-level documentation and JSDoc comments for:
DEFAULT_CENTERconstanthydrateCenterfunctiondehydrateCenterfunctioncenterAtomexportatoms/zoom.ts - Added file-level documentation and JSDoc comments for:
DEFAULT_ZOOMconstanthydrateZoomfunctiondehydrateZoomfunctionzoomAtomexportembed-exploration.tsx - Added file-level documentation and JSDoc comments for:
Cartostyled componentBaseTimelineContainerstyled componentCompareTimelineContainerstyled componentEmbeddedExplorationPropsinterfaceEmbeddedExplorationcomponentEmbeddedLayersExplorationPropsinterfacegetDataLayerhelper functionEmbeddedLayersExplorationcomponentcomponents/embed-exploration/embed-timeline.tsx - Added file-level documentation and JSDoc comments for:
TimelineWrapperstyled componentEmbedTimelinePropsinterfacegetCalendarViewhelper functionEmbedTimelinecomponentNotes & Questions About Changes
@fileoverview,@module,@param,@returns,@component, and@exampletags where appropriateValidation / Testing