chore: initial commit for TSDoc update #2927
Open
Conversation
This file contains 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.
docs: Add TSDoc comments to @libp2p/interface (#2112)
Description
This PR adds TSDoc comments to the public interfaces of
@libp2p/interface, ensuring that the documentation is properly structured and generated using the@packageDocumentationtag.Every exported interface, type, enum, and constant is documented according to the TSDoc standard.
Related issue: #2112
Notes & open questions
@maschad
I noticed that the original links in the issue no longer exist. Could you provide updated examples or confirm which specific files should be prioritized for these changes?
Change checklist