Skip to content

Add jsdoc annotations#506

Merged
harbournick merged 6 commits intosuperdoc-dev:mainfrom
johanneswilm:add-jsdoc-annotations
May 22, 2025
Merged

Add jsdoc annotations#506
harbournick merged 6 commits intosuperdoc-dev:mainfrom
johanneswilm:add-jsdoc-annotations

Conversation

@johanneswilm
Copy link
Copy Markdown
Contributor

First attempt to add jsdoc annotations to Editor.js and super-toolbar.js.
In some cases, I was not entirely sure, for example when arguments are not in use anywhere in a given method like here:
https://github.com/Harbour-Enterprises/SuperDoc/compare/main...johanneswilm:SuperDoc:add-jsdoc-annotations?expand=1#diff-cf578a6f4b5c61edc4820b992b2ecf85ac935fd7c6019e26b6b59076c7f0067fL563-L566

Comment thread packages/super-editor/src/core/Editor.js
Copy link
Copy Markdown
Contributor

@chittolinag chittolinag left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@johanneswilm thanks a lot for the help here! I know it's not a trivial task to add types for a somewhat unfamiliar codebase... I added a few comments and requested some changes - please let us know if you have any questions.

@harbournick cc ^

Comment thread packages/super-editor/src/components/toolbar/super-toolbar.js
Comment thread packages/super-editor/src/components/toolbar/super-toolbar.js
Comment thread packages/super-editor/src/components/toolbar/super-toolbar.js Outdated
Comment thread packages/super-editor/src/components/toolbar/super-toolbar.js
Comment thread packages/super-editor/src/components/toolbar/super-toolbar.js
Comment thread packages/super-editor/src/core/Editor.js
Comment thread packages/super-editor/src/core/Editor.js
Comment thread packages/super-editor/src/core/Editor.js Outdated
Comment thread packages/super-editor/src/core/Editor.js
Comment thread packages/super-editor/src/core/Editor.js
@harbournick
Copy link
Copy Markdown
Collaborator

@johanneswilm thanks for the great work here! I went through and resolved any comments no longer needed. Could you please resolve the merge conflict and resolve the final 5 comments? Thank you!

@johanneswilm
Copy link
Copy Markdown
Contributor Author

will do

@johanneswilm
Copy link
Copy Markdown
Contributor Author

@harbournick @chittolinag I have resolved the remaining issues - have a look though before merging as some of the solutions I used were different from what was initially suggested.

@harbournick harbournick merged commit 5ae07a8 into superdoc-dev:main May 22, 2025
2 of 3 checks passed
@johanneswilm johanneswilm deleted the add-jsdoc-annotations branch May 25, 2025 13:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants