Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

❓ API docs? #10

Closed
joebernard opened this issue Mar 1, 2021 · 4 comments · Fixed by #11
Closed

❓ API docs? #10

joebernard opened this issue Mar 1, 2021 · 4 comments · Fixed by #11
Labels
📚 documentation Improvements or additions to documentation

Comments

@joebernard
Copy link

I was hoping to explore some API docs for the camera. Do you have those available somewhere or should I just rely on the example app for now?
@joebernard joebernard added the 💭 question Further information is requested label Mar 1, 2021
@mrousavy
Copy link
Owner

mrousavy commented Mar 1, 2021

Hi! I currently don't have docs for web-viewing available, but everything is thoroughly documented in the JSDoc (TypeScript definitions). Ideally I want to automatically build those and host them on GitHub pages, will have to take a look at that when I find some free time. 👍

@mrousavy mrousavy added 📚 documentation Improvements or additions to documentation enhancement and removed 💭 question Further information is requested labels Mar 1, 2021
@mrousavy
Copy link
Owner

mrousavy commented Mar 1, 2021

Let's leave this issue open until docs are available

@mrousavy mrousavy reopened this Mar 1, 2021
@mrousavy mrousavy mentioned this issue Mar 2, 2021
Merged
2 tasks
@mrousavy
Copy link
Owner

mrousavy commented Mar 4, 2021

Hey! Forgot to get back to you. Docs are live at cuvent.github.io/react-native-vision-camera, and API is automatically generated at /docs/api - let me know what you think 😄👍

@joebernard
Copy link
Author

Excellent. I'm using react-native-camera right now and was always disappointed I could not use the multiple lenses on the later iPhones. Really excited to experiment with this and having good docs will help.

@Mohamed-kassim Mohamed-kassim mentioned this issue Mar 16, 2022
Closed
4 tasks
@palagonKevo palagonKevo mentioned this issue Mar 31, 2022
Closed
4 tasks
@MajorTom007 MajorTom007 mentioned this issue Nov 14, 2023
Closed
4 tasks
@netdown netdown mentioned this issue Nov 23, 2023
Closed
5 tasks
@cseluzha cseluzha mentioned this issue Dec 12, 2023
Closed
5 tasks
@TheGhostFish TheGhostFish mentioned this issue Apr 22, 2024
Closed
4 tasks
@P0diceps P0diceps mentioned this issue Jun 18, 2024
Open
5 tasks
@kHanHnq4901 kHanHnq4901 mentioned this issue Oct 28, 2024
Open
5 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
📚 documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Automatically build API documentation mrousavy/react-native-vision-camera
2 participants
@joebernard @mrousavy