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

Java: show the XDR source code in the javadoc #196

Merged

Conversation

overcat
Copy link
Contributor

@overcat overcat commented May 15, 2024

Previously, the way we rendered comments prevented XDR definitions from being displayed in javadoc, in this PR we have added it.

See lightsail-network/java-stellar-sdk#595

@overcat
Copy link
Contributor Author

overcat commented May 15, 2024

Hi @JakeUrban, can you review the PR?

@overcat overcat force-pushed the java-source-comment branch 2 times, most recently from 8cc560e to dedb7d0 Compare May 15, 2024 09:35
@leighmcculloch leighmcculloch merged commit 6cd7f3b into stellar:master May 15, 2024
3 checks passed
@leighmcculloch
Copy link
Member

Nice, thanks for fixing the comment rendering.

Some day it'd be awesome if it also took the comments in the XDR and made them available to the generators for inserting into the code. So that comments on an enum value, could be rendered by a generator onto the enum written into the code. And same for struct fields, structs themselves, etc.

@overcat overcat deleted the java-source-comment branch May 15, 2024 11:47
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

Successfully merging this pull request may close these issues.

2 participants