This repository has been archived by the owner on Jun 28, 2024. It is now read-only.
Fix api documentation #11
Closed
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
graszka22
reviewed
Aug 6, 2023
| # Package com.jellyfishdev.jellyfishclient.webrtc | ||
|
|
||
| See [membrane-webrtc-android docs](https://jellyfish-dev.github.io/membrane-webrtc-android/) for API documentation. |
There was a problem hiding this comment.
I'm confused now, those are docs for webrtc, not jellyfish? Is it intentional?
There was a problem hiding this comment.
Yes, those docs are there to provide an quick and easy way for jellyfish client user to understand how the webrtc functions that we're exposing through type aliases work. There is no easy way of exporting docs for types I made aliases of, and copy pasting them seems like a huge mistake, so I figured that this is the best solution
mironiasty
pushed a commit
that referenced
this pull request
Apr 29, 2024
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Fixed docs can be seen by clicking the link in the readme of this branch