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.

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

Add docs to C, C++, JS #630

Open
robertbastian opened this issue Aug 14, 2024 · 2 comments
Open

Add docs to C, C++, JS #630

robertbastian opened this issue Aug 14, 2024 · 2 comments
Labels
B-C C backends B-cpp C++ backend B-js JS backend documentation Improvements or additions to documentation good first issue Good for newcomers
Milestone

Comments

@robertbastian
Copy link
Collaborator

These three HIR backends do not currently produce docs. See the Dart backend for an example.

@robertbastian robertbastian added documentation Improvements or additions to documentation good first issue Good for newcomers B-C C backends B-cpp C++ backend B-js JS backend labels Aug 14, 2024
@YJDoc2
Copy link

YJDoc2 commented Aug 28, 2024

Hey, is this issue related to adding the doc comments, or the doc comments not actually producing rust docs? I was looking in https://github.com/rust-diplomat/diplomat/tree/main/tool/src/c , and https://github.com/rust-diplomat/diplomat/tree/main/tool/src/js , the source files seem to have doc comments. Is there any other kind of documentation to be added, or am I looking in wrong places?

@Manishearth
Copy link
Contributor

Manishearth commented Aug 28, 2024

This issue is about adding some form of documentation (comments, sphinx, something) to the code generated by these backends.

This isn't about rustdoc.

@robertbastian robertbastian added this to the ICU4X 2.0 milestone Sep 10, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
B-C C backends B-cpp C++ backend B-js JS backend documentation Improvements or additions to documentation good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

3 participants