Bug 16875 - wrong member signatures in xml comment documentation
Summary: wrong member signatures in xml comment documentation
Status: NEW
Alias: None
Product: Documentation
Classification: Xamarin
Component: Mono for Android ()
Version: unspecified
Hardware: PC Windows
: --- normal
Target Milestone: ---
Assignee: Larry O'Brien
URL:
Depends on:
Blocks:
 
Reported: 2013-12-18 08:53 UTC by Andrew
Modified: 2015-11-04 15:42 UTC (History)
2 users (show)

Tags:
Is this bug a regression?: ---
Last known good build:

Notice (2018-05-24): bugzilla.xamarin.com is now in read-only mode.

Please join us on Visual Studio Developer Community and in the Xamarin and Mono organizations on GitHub to continue tracking issues. Bugzilla will remain available for reference in read-only mode. We will continue to work on open Bugzilla bugs, copy them to the new locations as needed for follow-up, and add the new items under Related Links.

Our sincere thanks to everyone who has contributed on this bug tracker over the years. Thanks also for your understanding as we make these adjustments and improvements for the future.


Please create a new report for Bug 16875 on Developer Community or GitHub if you have new information to add and do not yet see a matching new report.

If the latest results still closely match this report, you can use the original description:

  • Export the original title and description: Developer Community HTML or GitHub Markdown
  • Copy the title and description into the new report. Adjust them to be up-to-date if needed.
  • Add your new information.

In special cases on GitHub you might also want the comments: GitHub Markdown with public comments

Related Links:
Status:
NEW

Description Andrew 2013-12-18 08:53:27 UTC
Here's an example:

-----------------------------
<member name="F:Android.App.PendingIntentFlags.CancelCurrent">
            <summary>
                <para tool="javadoc-to-mdoc">Flag for use with <see cref="M:Android.App.PendingIntent.GetActivity(Android.Content.Context, System.Int32, System.Int32, System.Int32)" />, <see cref="M:Android.App.PendingIntent.GetBroadcast(Android.Content.Context, System.Int32, System.Int32, System.Int32)" />, and
 <see cref="M:Android.App.PendingIntent.GetService(Android.Content.Context, System.Int32, System.Int32, System.Int32)" />: if the described PendingIntent already exists,
 the current one is canceled before generating a new one.  You can use
 this to retrieve a new PendingIntent when you are only changing the
 extra data in the Intent; by canceling the previous pending intent,
 this ensures that only entities given the new data will be able to
 launch it.  If this assurance is not an issue, consider
 <see cref="F:Android.App.PendingIntentFlags.UpdateCurrent" />.
</para>
            </summary>
        </member>
-----------------------------

Consider cref value:

<see cref="M:Android.App.PendingIntent.GetActivity(Android.Content.Context, System.Int32, System.Int32, System.Int32)" />

There's no member with such signature in Monodroid, and the cref isn't displayed correctly in quick doc popup.
The actual signature is:

public static PendingIntent GetActivity(Context context, int requestCode, Intent intent, [GeneratedEnum] PendingIntentFlags flags)

So the cref should look like (and this one displayed properly as a link in VS):

<see cref="M:Android.App.PendingIntent.GetActivity(Android.Content.Context,System.Int32,Android.Content.Intent,Android.App.PendingIntentFlags)" />

Note that it's just an example of a wrong signature that I run down, I expect there will be more such issues.
Comment 1 Andrew 2013-12-18 08:54:23 UTC
Xamarin.Android   4.10.01073 (d23a19bf)

C:\Program Files (x86)\Reference
Assemblies\Microsoft\Framework\MonoAndroid\v4.0\Mono.Android.dll
c:\Program Files (x86)\Reference
Assemblies\Microsoft\Framework\MonoAndroid\v4.0\Mono.Android.xml
Comment 2 Joel Martinez 2015-11-04 15:42:12 UTC
Not sure if this is resolved in the latest iterations of the javadoc-to-mdoc process ... but that would be the likely place for this to be fixed.