Bug 2127 - Generate XML comments for user resources
Summary: Generate XML comments for user resources
Status: RESOLVED NOT_ON_ROADMAP
Alias: None
Product: Android
Classification: Xamarin
Component: Tools and Addins ()
Version: 2.0
Hardware: PC Windows
: --- enhancement
Target Milestone: ---
Assignee: Bugzilla
URL:
Depends on:
Blocks:
 
Reported: 2011-11-21 15:33 UTC by Jonathan Pobst
Modified: 2012-04-25 15:41 UTC (History)
1 user (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 NOT_ON_ROADMAP

Description Jonathan Pobst 2011-11-21 15:33:56 UTC
From: https://bugzilla.novell.com/show_bug.cgi?id=665396

Aresgen.exe should generate XML Comments (triple-slash comments) for the types
that are parsed from resources.  In particular, it should be made clear in the
VS tool tips what XML keys "2nd level" types map to, per the changes in this
bug:  https://bugzilla.novell.com/show_bug.cgi?id=661517

--

In addition to having the doc comments say what the type mapping was in the doc
comments for the type declaration, i.e.

        /// <summary>
        /// Graphics resources read from Resources/Drawable* directories
        /// </summary>
        public partial class Drawable

We should output any information we've parsed that might be useful to see in
the tooltip.

For instance, instead of:

            // aapt resource value: 0x7f030000
            public const int Main = 2130903040;

Generate:
            /// <summary>
            /// Layout resource located in Resources/Values/Main.axml
            /// </summary>
            /// <remarks>
            /// aapt resource value: 0x7f030000
            /// </remarks>
            public const int Main = 2130903040;


Or instead of:
            // aapt resource value: 0x7f040000
            public const int Hello = 2130968576;


Generate:
            /// <summary>
            /// String resource read from string element with name "Hello", 
            /// located on line 3 of Resources/Values/Strings.xml
            /// <para>Value: "Hello World, Click Me!"</para>
            /// </summary>
            /// <remarks>
            /// aapt resource value: 0x7f040000
            /// </remarks>    
            public const int Hello = 2130968576;
Comment 1 Jonathan Pobst 2012-04-25 15:41:30 UTC
Aapt doesn't provide us any of the data needed to do this, and it doesn't seem like anyone's brought this up in over a year, so let's pass on this.