[Java.Interop.Tools.JavaSource] Fix tag parsing errors#997
Merged
jonpryor merged 2 commits intodotnet:mainfrom Jun 30, 2022
Merged
[Java.Interop.Tools.JavaSource] Fix tag parsing errors#997jonpryor merged 2 commits intodotnet:mainfrom
jonpryor merged 2 commits intodotnet:mainfrom
Conversation
pjcollins
force-pushed
the
parse-exceptions
branch
from
a11ab3d to
72bd0b1
Compare
pjcollins
changed the title
The number of "## Unable to translate remarks for ..." errors have been
cut nearly in half, from 740 to 391.
The rules for `@param`, `@return`, `@throws`, and `@unknown` have been
updated to handle more variations of these tags. In some cases, these
tags are only followed by a single word or no content at all.
New line character filters have been added to `nonSpaceTerm` to fix
instances where an "empty" tag would be merged with a tag on a new line.
See [`Android.Database.DatabaseUtils.GetCollationKey(String)`][0].
Before `nonSpaceTerm` change:
<param name="name">To be added.</param>
<param name="name
@return
@return">the collation key</param>
<summary>return the collation key</summary>
<returns>To be added.</returns>
After `nonSpaceTerm` change:
<param name="name">name</param>
<summary>return the collation key</summary>
<returns>the collation key</returns>
New (mostly empty) rules for `@hide`, `@inheritDoc`, and `@{see}` tags
have also been added.
[0]: https://github.com/xamarin/android-api-docs/blob/a7e914965a0e80c9454149399551d87a18997b2e/docs/Mono.Android/en/Android.Database/DatabaseUtils.xml#L1505-L1508
pjcollins
force-pushed
the
parse-exceptions
branch
from
72bd0b1 to
1f9aac4
Compare
pjcollins
commented
Jun 28, 2022
...s.JavaSource/Java.Interop.Tools.JavaSource/SourceJavadocToXmldocGrammar.BlockTagsBnfTerms.cs
Show resolved
Hide resolved
jonpryor
reviewed
Jun 30, 2022
...s.JavaSource/Java.Interop.Tools.JavaSource/SourceJavadocToXmldocGrammar.BlockTagsBnfTerms.cs
Outdated
Show resolved
Hide resolved
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The number of "## Unable to translate remarks for ..." errors have been
cut nearly in half, from 740 to 391.
The rules for
@param,@return,@throws, and@unknownhave beenupdated to handle more variations of these tags. In some cases, these
tags are only followed by a single word or no content at all.
New line character filters have been added to
nonSpaceTermto fixinstances where an "empty" tag would be merged with the tag on the
following line.
See
Android.Database.DatabaseUtils.GetCollationKey(String)asan example.
Before
nonSpaceTermchange:After
nonSpaceTermchange:New (mostly empty) rules for
@hide,@inheritDoc, and@{see}tagshave also been added.