Bug 58795 - *Async doc generator copies non-async summary text into asyn summary in toto
Summary: *Async doc generator copies non-async summary text into asyn summary in toto
Status: CONFIRMED
Alias: None
Product: iOS
Classification: Xamarin
Component: Documentation ()
Version: XI 10.99 (xcode9)
Hardware: PC Mac OS
: --- enhancement
Target Milestone: Future Cycle (TBD)
Assignee: Bugzilla
URL:
Depends on:
Blocks:
 
Reported: 2017-08-15 22:19 UTC by Mike Norman
Modified: 2017-09-07 09:52 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 58795 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:
CONFIRMED

Description Mike Norman 2017-08-15 22:19:03 UTC
Expected:
Autogenerated FooAsync method summaries do not contain text about completion handlers.

Actual:
In particular for non-async methods that have a completion handler, the summary text of many methods are copied into the equivalent *Async methods. I've noticed a number of these in MonoTouch.UIKit.UIPrinterPickerController, fixing a few of them as a result of other work.

Note: While I suspect this is the docfixer or similar tool because the text manifests the related bug, https://bugzilla.xamarin.com/show_bug.cgi?id=58447, this is a separate issue. Also, a "real" fix for this issue can only be achieved if we were to templatize method summaries to the point where we had access to the individual clauses in the description. It's probably best, in the meantime, to simply not copy the non-async summaries into their async equivalents.