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

C# bindings have mangled documentation #17

Open
kaesaecracker opened this issue Oct 20, 2024 · 1 comment
Open

C# bindings have mangled documentation #17

kaesaecracker opened this issue Oct 20, 2024 · 1 comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@kaesaecracker
Copy link
Collaborator

C# uses XML tags to format the docs.

There are two main options here:

  1. write all the C# docs manually
  2. build / use a converter

While (1) would result in the best quality docs, the duplicate effort would probably mean lower coverage. (2) would be preferred.

@kaesaecracker kaesaecracker added documentation Improvements or additions to documentation enhancement New feature or request labels Oct 20, 2024
@kaesaecracker
Copy link
Collaborator Author

with #20, the binding will not have any documentation at all :o

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant