Skip to content

[Java.Interop.Tools.JavaSource] Fix remaining parsing errors #1036

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
Sep 28, 2022

Conversation

pjcollins
Copy link
Member

@pjcollins pjcollins commented Sep 14, 2022

Fixes: #850

All 431 instances of JavadocImport-Error that would occur when
generating API docs for Mono.Android.dll have been fixed. Problematic
scenarios that have been fixed include:

  • @hide and @inheritDoc tags with trailing content
  • <tt> or <i> elements with no closing tag
  • <pre> elements with an attribute and/or no closing elements
  • <a name=""> or <a id=""> elements inside of an unclosed <p> element
  • <a href=""> elements with mixed casing or spacing
  • {https://github.com/link foo tags without a closing bracket
  • Any extra occurances of @, {, or }

@pjcollins pjcollins force-pushed the dev/pjc/fix-jdi-errors branch from b57884c to 103cc8e Compare September 15, 2022 01:24
@pjcollins pjcollins changed the title Fix all remaining remarks translation errors [Java.Interop.Tools.JavaSource] Fix remaining parsing errors Sep 15, 2022
@pjcollins
Copy link
Member Author

All of the error messages have been fixed, but there are still 88 exceptions (## Exception translating remarks ...) to address in a future PR.

@pjcollins pjcollins marked this pull request as ready for review September 15, 2022 02:29
@pjcollins pjcollins marked this pull request as draft September 15, 2022 02:46
@pjcollins
Copy link
Member Author

Testing this with this docs update: xamarin/android-api-docs#39, at a glance I can see there is an issue with the fix for broken {@link tags that will need adjusting.

@pjcollins pjcollins force-pushed the dev/pjc/fix-jdi-errors branch 2 times, most recently from 161ba94 to e5962b5 Compare September 19, 2022 21:46
All 431 instances of `JavadocImport-Error` that would occur when
generating API docs for Mono.Android.dll have been fixed.  Problemetic
scenarios that have been fixed include:

 * `@hide` and `@inheritDoc` tags with trailing content
 * `<tt>` or `<i>` elements with no closing tag
 * `<pre>` elements with an attribute and/or no closing elements
 * `<a name="">` or `<a id="">` elements inside of an unclosed `<p>` element
 * `<a href="">` elements with mixed casing or spacing
 * `{@link foo` tags without a closing bracket
 * Any extra occurances of `@`, `{`, or `}`
@pjcollins pjcollins force-pushed the dev/pjc/fix-jdi-errors branch from e5962b5 to 39a0154 Compare September 19, 2022 23:01
@pjcollins pjcollins marked this pull request as ready for review September 19, 2022 23:02
@pjcollins
Copy link
Member Author

The diff in xamarin/android-api-docs#39 is looking better now, this should be ready for review.

@jonpryor jonpryor merged commit a0728ed into main Sep 28, 2022
@jonpryor jonpryor deleted the dev/pjc/fix-jdi-errors branch September 28, 2022 21:09
@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.

XML syntax warnings when using JavaSourceJar
2 participants