Bug 8775 - Mimic Visual Studio documentation without appending new lines for sections other than summary.
Summary: Mimic Visual Studio documentation without appending new lines for sections ot...
Status: RESOLVED FIXED
Alias: None
Product: Xamarin Studio
Classification: Desktop
Component: Text Editor ()
Version: Trunk
Hardware: PC Mac OS
: Low normal
Target Milestone: ---
Assignee: Mike Krüger
URL:
Depends on:
Blocks:
 
Reported: 2012-12-05 11:39 UTC by Thomas Holloway
Modified: 2012-12-06 01:21 UTC (History)
1 user (show)

Tags: docfood,xml documentation,monodevelop
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 Thomas Holloway 2012-12-05 11:39:17 UTC
Currently, when you use the XML documentation in MonoDevelop ala ///, this will generate documentation that looks similar to the following:

/// <summary>
/// Summary here.
/// </summary>
/// <param name='id'>
/// Identifier.
/// </param>

This is different than the Visual Studio behavior of the following:

/// <summary>
/// Summary here.
/// </summary>
/// <param name="id">Identifier.</param>

DocFood should be generating docs that mimic this behavior for ease of use.
Comment 1 Mike Krüger 2012-12-06 01:21:20 UTC
Thanks for the fix - I merged your changes.