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.

Sign up for GitHub

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

Jump to bottom

[API Docs] Invalid parameter values for certain overloads in ObjectAnimator #933

Closed
pjcollins opened this issue Dec 10, 2021 · 0 comments · Fixed by #934
Closed

[API Docs] Invalid parameter values for certain overloads in ObjectAnimator #933

pjcollins opened this issue Dec 10, 2021 · 0 comments · Fixed by #934
Assignees
@pjcollins

Comments

@pjcollins
Copy link
Member

Looking at the generated ObjectAnimator.cs MCW, we seem to have an issue with Javadoc conversion related to certain overloads:
https://gist.github.com/pjcollins/8f5d3d30877dab7f4f58d7324c8e9672

All four overloads contain the same <param> values, regardless of their signature:

/// <param name="target">The object whose properties are to be animated.</param>
/// <param name="xProperty">The property for the x coordinate being animated.</param>
/// <param name="yProperty">The property for the y coordinate being animated.</param>
/// <param name="path">The &lt;code&gt;Path&lt;/code&gt; to animate values along.</param>

This is seemingly causing some issues with a recent API docs update, where we have a handful of invalid <param/> values in:
https://github.com/xamarin/android-api-docs/blob/fda1236a384b228b46033fd624854851a87c08df/docs/Mono.Android/en/Android.Animation/ObjectAnimator.xml#L204-L418

A similar issue was noted in #931.
@pjcollins pjcollins self-assigned this Dec 10, 2021
@pjcollins pjcollins mentioned this issue Dec 10, 2021
Merged
pjcollins added a commit to pjcollins/java.interop that referenced this issue Dec 14, 2021
@pjcollins
[generator] Use the correct javadoc element
863547e 
Fixes: dotnet#933

Fixes a bug when attempting to find the `<javadoc/>` element that is
associated with a specific member name and jni-signature.  When a type
contained multiple members with the same name, we would always return
the first `<javadoc/>` that matched the member name, rather than the
one that matched both the name and signature.
@pjcollins pjcollins mentioned this issue Dec 14, 2021
Merged
pjcollins added a commit that referenced this issue Dec 14, 2021
@pjcollins
[generator] Use the correct javadoc element (#934)
d64087c 
Fixes: #933

Fixes a bug when attempting to find the `<javadoc/>` element that is
associated with a specific member name and jni-signature.  When a type
contained multiple members with the same name, we would always return
the first `<javadoc/>` that matched the member name, rather than the
one that matched both the name and signature.
pjcollins added a commit to xamarin/android-api-docs that referenced this issue Dec 15, 2021
@pjcollins
Update docs using dotnet/java-interop@d64087cf (#29)
a7e9149 
Fixes: dotnet/java-interop#933
Context: dotnet/java-interop#931
Context: dotnet/java-interop#932

Changes: dotnet/java-interop@087684a...d64087c

Changes: dotnet/android@aea70ca...05dd813

Changes of note:

  * Includes a bunch of fixes for method overloads.

  * Documentation URLs have been updated to *better* match what the
    Android doc link should be.
    *Note*: these are still not all *correct*; See dotnet/java-interop#931
    and dotnet/java-interop#932.

No new documentation warnings or suggestions have been introduced:

    Total Build Warnings | 1124
    Total Build Suggestions | 902
pjcollins added a commit to xamarin/android-api-docs that referenced this issue Dec 20, 2021
@pjcollins
Update docs using dotnet/java-interop@d64087cf (#29)
6d6eb07 
Fixes: dotnet/java-interop#933
Context: dotnet/java-interop#931
Context: dotnet/java-interop#932

Changes: dotnet/java-interop@087684a...d64087c

Changes: dotnet/android@aea70ca...05dd813

Changes of note:

  * Includes a bunch of fixes for method overloads.

  * Documentation URLs have been updated to *better* match what the
    Android doc link should be.
    *Note*: these are still not all *correct*; See dotnet/java-interop#931
    and dotnet/java-interop#932.

No new documentation warnings or suggestions have been introduced:

    Total Build Warnings | 1124
    Total Build Suggestions | 902
@pjcollins pjcollins mentioned this issue Dec 20, 2021
Merged
pjcollins added a commit to xamarin/android-api-docs that referenced this issue Dec 21, 2021
@pjcollins
Merge pull request #31 from xamarin/dev/pjc/merge-ji-d3f0c5c-live
099ecf9 
Fixes: dotnet/java-interop#931
Fixes: dotnet/java-interop#932
Fixes: dotnet/java-interop#933

Changes of note:

  * Includes a bunch of fixes for method overloads.

  * Documentation URLs have been fixed for type members with complex
     parameters.
davidbritch added a commit to xamarin/android-api-docs that referenced this issue Sep 14, 2022
@shawnwang-ms @pjcollins
@davidbritch @TianqiZhang
Merge main to live (#38)
10da545 
* Update docs using dotnet/java-interop@d64087cf (#29)

Fixes: dotnet/java-interop#933
Context: dotnet/java-interop#931
Context: dotnet/java-interop#932

Changes: dotnet/java-interop@087684a...d64087c

Changes: dotnet/android@aea70ca...05dd813

Changes of note:

  * Includes a bunch of fixes for method overloads.

  * Documentation URLs have been updated to *better* match what the
    Android doc link should be.
    *Note*: these are still not all *correct*; See dotnet/java-interop#931
    and dotnet/java-interop#932.

No new documentation warnings or suggestions have been introduced:

    Total Build Warnings | 1124
    Total Build Suggestions | 902

* Update docs using dotnet/java-interop@d3f0c5c (#30)

Fixes: dotnet/java-interop#931
Fixes: dotnet/java-interop#932
Context: dotnet/java-interop@d3f0c5c

Fixes reference documentation URLs for type members with complex
parameters.

* Master becomes main.

* Update docs using dotnet/java-interop@7716ae53 (#33)

Updates API docs against:

  * dotnet/android@bb2f920
  * dotnet/java-interop@51c3dae

Notable generator improvements include:

  * dotnet/java-interop@4cbc07a
  * dotnet/java-interop@13def0e
  * dotnet/java-interop@32635fd

* Update docs using dotnet/android@ace5f71c (#34)

Imports Google-provided API-31 Javadoc documentation for nested types
that were previously being ignored.

Notable documentation related generator changes:

  * dotnet/java-interop@4b4fedd3: [generator] Process Javadoc for nested types
  * dotnet/java-interop@265ad762: [Java.Interop.Tools.JavaSource] Fix tag parsing errors

Changes in xamarin-android and java.interop:

  * dotnet/android@c6dcefb...ace5f71
  * dotnet/java-interop@7716ae5...032f1e7

* [SEO][Rollout Monikered Canonical]Add URL moniker (#37)

Enable build config to generate canonical URL with moniker

Co-authored-by: Peter Collins <pecolli@microsoft.com>
Co-authored-by: David Britch <davidbritch@users.noreply.github.com>
Co-authored-by: Tianqi Zhang <TianqiZhang@users.noreply.github.com>
@github-actions github-actions bot locked and limited conversation to collaborators Apr 13, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees

@pjcollins pjcollins

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

[generator] Use the correct javadoc element pjcollins/java.interop
1 participant
@pjcollins