Bug 7819 - JAR Bindings should generation class/method documentation from javadocs
Summary: JAR Bindings should generation class/method documentation from javadocs
Status: RESOLVED FIXED
Alias: None
Product: Android
Classification: Xamarin
Component: Bindings ()
Version: 4.2.x
Hardware: PC Windows
: Normal enhancement
Target Milestone: ---
Assignee: Atsushi Eno
URL:
: 9308 ()
Depends on:
Blocks:
 
Reported: 2012-10-12 14:17 UTC by Jeremy Kolb
Modified: 2014-04-22 06:42 UTC (History)
3 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 on Developer Community or GitHub with your current version information, steps to reproduce, and relevant error messages or log files if you are hitting an issue that looks similar to this resolved bug and you do not yet see a matching new report.

Related Links:
Status:
RESOLVED FIXED

Description Jeremy Kolb 2012-10-12 14:17:32 UTC
Currently if you specify JavadocPaths in a csproj parameter names will be generated.  It would be incredibly useful if comments for methods/classes/fields could also be extracted and added to the generated assemblies.
Comment 1 Steve Williams 2013-01-06 22:04:04 UTC
Related to #7797?
https://bugzilla.xamarin.com/show_bug.cgi?id=7819
Comment 2 Steve Williams 2013-01-06 22:04:37 UTC
Gah.  Wrong link.
https://bugzilla.xamarin.com/show_bug.cgi?id=7797
Comment 3 Atsushi Eno 2013-01-07 01:37:55 UTC
#7797 is only about javadoc format difference (it seems, between 6 and 7) and has nothing to do with this.
Comment 4 Steve Williams 2013-01-07 02:53:25 UTC
We would need to be able to transform any imported comments to match our API transforms, and be able to add comments where they don't exist.
Comment 5 Atsushi Eno 2013-01-07 03:43:02 UTC
*** Bug 9308 has been marked as a duplicate of this bug. ***
Comment 6 Atsushi Eno 2014-04-22 06:42:39 UTC
In a couple of releases ago, we have introduced JavaDocIndex build action for index.html of API reference (expected to have symbolic link when the doc is not under the project folder).

(Sorry I have been reviewing existing bugs and noticed it's still open.)