Skip to content

[generator] Process javadoc for nested types #996

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

Merged
merged 1 commit into from
Jun 27, 2022

Conversation

pjcollins
Copy link
Member

Fixes: #992

Looking at the latest set of API docs for a nested type I noticed
that we were missing a lot of content that should have been produced by
the Mono.Android build when translating Javadoc to C# doc comments.

After further investigation, we realized that we were not attempting to
process and translate Javadoc for any nested types. This has been
fixed by adding a missing Javadoc processing iteration over each types
nested type.

Additionally, Java documentation URLs for nested types have been fixed
by replacing '$' with '.' in both the URL and text for the URL.

Fixes: dotnet#992

Looking at the latest set of API docs for [a nested type][0] I noticed
that we were missing a lot of content that should have been produced by
the Mono.Android build when translating Javadoc to C# doc comments.

After further investigation, we realized that we were not attempting to
process and translate Javadoc for _any_ nested types.  This has been
fixed by adding a missing Javadoc processing iteration over each types
nested type.

Additionally, Java documentation URLs for nested types have been fixed
by replacing '$' with '.' in both the URL and text for the URL.

[0]: https://github.com/xamarin/android-api-docs/blame/b4084443c0354661e2257eb698e03d3fe1d86f1b/docs/Mono.Android/en/Android.AccessibilityServices/AccessibilityButtonController%2BAccessibilityButtonCallback.xml#L25
@pjcollins pjcollins requested a review from jonpryor June 16, 2022 23:17
@jonpryor jonpryor merged commit 4b4fedd into dotnet:main Jun 27, 2022
@pjcollins pjcollins deleted the doclink-fix-992 branch June 30, 2022 17:26
@github-actions github-actions bot locked and limited conversation to collaborators Apr 12, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Javadoc Import & Nested Types
2 participants