Bug 10432 - xml documentation not generated
Summary: xml documentation not generated
Status: RESOLVED DUPLICATE of bug 15060
Alias: None
Product: Tools
Classification: Mono
Component: xbuild ()
Version: unspecified
Hardware: PC Linux
: --- normal
Target Milestone: ---
Assignee: Bugzilla
Depends on:
Reported: 2013-02-19 06:56 UTC by Peter Hultqvist
Modified: 2013-10-10 18:40 UTC (History)
2 users (show)

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 GitHub or Developer Community 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:

Description Peter Hultqvist 2013-02-19 06:56:38 UTC
I have started a new solution in monodevelop and checked the "Generate xml documentation" checkbox.

I expected some .xml files to be generated when building the solution, however none are generated.

I tried to compile a file manually using gmcs /doc:.... which did generate the xml file.

Looking at the Build output in monodevelop I can see no mention of the /doc argument.

Target CoreCompile:
		Tool /usr/bin/gmcs execution started with arguments: /noconfig /debug:full /debug+ /optimize- /out:obj/Debug/Test.dll MyClass.cs Properties/AssemblyInfo.cs /target:library /define:DEBUG /reference:/usr/lib/mono/2.0/System.dll /reference:/usr/lib/mono/2.0/System.Core.dll /warn:4

Also building the solution using xbuild does not generate any xml files and the console output does not indicate that /doc was passed.

	Target CoreCompile:
				Tool /usr/bin/gmcs execution started with arguments: /noconfig /debug:full /debug+ /optimize- /out:obj/Debug/Test.dll MyClass.cs Properties/AssemblyInfo.cs /target:library /define:DEBUG /reference:/usr/lib/mono/2.0/System.dll /reference:/usr/lib/mono/2.0/System.Core.dll /warn:4
Comment 1 Peter Hultqvist 2013-02-19 06:57:16 UTC
xbuild -version
XBuild Engine Version
Mono, Version
Comment 2 Kevin Mullins 2013-02-22 11:09:57 UTC
I am seeing the exact same behavior, even though I have checked the "Generate XML Documentation" box, no documentation is being created and the option is not being added to the compile command line.

XBuild Engine Version
Mono, Version

I use this feature quite a bit and realy need this back ASAP!
Comment 3 Kevin Mullins 2013-02-22 11:37:58 UTC
Actually I did a little more digging and found out that the call to the smcs compiler from the "Build Output" pad DID include the "/doc:..." command I did get warnings on the XML content but no file was generated.


Building Solution: NavigationBar (Release)

Building: NavBar (Release)
Performing main compilation...
/Developer/MonoTouch/usr/bin/smcs /noconfig "/out:/Users/kmullins/Projects/NavigationBar/NavigationBar/bin/Release/NavBar.dll" "/r:/Developer/MonoTouch/usr/lib/mono/2.1/System.dll" "/r:/Developer/MonoTouch/usr/lib/mono/2.1/System.Xml.dll" "/r:/Developer/MonoTouch/usr/lib/mono/2.1/System.Core.dll" "/r:/Developer/MonoTouch/usr/lib/mono/2.1/monotouch.dll" /nologo /warn:4 /optimize+ /codepage:utf8 "/define:xTRIAL"  /t:library "/Users/kmullins/Projects/NavigationBar/NavigationBar/Classes/UINavBar.cs" "/Users/kmullins/Projects/NavigationBar/NavigationBar/Classes/UINavBarAppearance.cs" "/Users/kmullins/Projects/NavigationBar/NavigationBar/Classes/UINavBarPointer.cs" "/Users/kmullins/Projects/NavigationBar/NavigationBar/Classes/UINavBarButton.cs" "/Users/kmullins/Projects/NavigationBar/NavigationBar/Classes/UINavBarButtonAppearance.cs" "/Users/kmullins/Projects/NavigationBar/NavigationBar/Classes/UINavBarButtonState.cs" "/Users/kmullins/Projects/NavigationBar/NavigationBar/Classes/UINavBarButtonCollection.cs" "/Users/kmullins/Projects/NavigationBar/NavigationBar/Classes/UINavBarButtonType.cs" "/Users/kmullins/Projects/NavigationBar/NavigationBar/SupportingClasses/NavBarImage.cs" "/doc:/Users/kmullins/Projects/NavigationBar/NavigationBar/bin/Release/NavBar.xml" 
Compilation succeeded - 1 warning(s)

/Users/kmullins/Projects/NavigationBar/NavigationBar/Classes/UINavBar.cs(132,29): warning CS0114: `Appracatappra.UIKit.NavBar.UINavBar.Hidden' hides inherited member `MonoTouch.UIKit.UIView.Hidden'. To make the current member override that implementation, add the override keyword. Otherwise add the new keyword
/Developer/MonoTouch/usr/lib/mono/2.1/monotouch.dll (Location of the symbol related to previous warning)

Build: 0 errors, 2 warnings

If I switch out the smcs compiler for the gmcs compiler the XML file is created.
Comment 4 Bojan Rajkovic [MSFT] 2013-02-22 12:40:45 UTC
The smcs compiler does not support doc comments in the current Mono 2.10.x-based releases. This will change in the 3.0-based releases slated for Xamarin Evolve.
Comment 5 Mikayla Hutchinson [MSFT] 2013-02-22 12:49:35 UTC
Also, Xamarin.iOS (MonoTouch) projects don't use xbuild yet.
Comment 6 Mikayla Hutchinson [MSFT] 2013-10-10 18:40:46 UTC
Original issue is fixed by bug 15060, comment 3 is a different issue that was fixed by Xamarin.iOS upgrading to the Mono 3.x C# compiler.

*** This bug has been marked as a duplicate of bug 15060 ***