Skip to content

About document generation #25

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

Closed
oovm opened this issue Apr 13, 2023 · 3 comments
Closed

About document generation #25

oovm opened this issue Apr 13, 2023 · 3 comments

Comments

@oovm
Copy link
Contributor

oovm commented Apr 13, 2023

Existing documentation generation seems to simply add summary?

It does not convert rustdoc markdown syntax to C# doc syntax.

How about remove the summary, and I can directly write xml-style C# documents?

@neuecc
Copy link
Member

neuecc commented Apr 14, 2023

I understand that it is quite inadequate, since per argument COMMENT is not supported either.
rust-lang/rust#57525
However, I am not willing to add any special mechanism.

@neuecc neuecc closed this as completed Apr 14, 2023
@jakob-ledermann
Copy link

How about adding the same mechanism as bindgen did with parse_callbacks and ParseCallbacks::process_comment?
That would allow users to write their own document converters.

@neuecc
Copy link
Member

neuecc commented Jul 5, 2023

I feel like it might not be too bad, but since I can't quite picture it, the status is more like "I might do it someday".

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants