Bug 3726 - Unexpected symbol '<' in what should be valid xml documentation
Summary: Unexpected symbol '<' in what should be valid xml documentation
Status: RESOLVED FIXED
Alias: None
Product: Compilers
Classification: Mono
Component: C# ()
Version: unspecified
Hardware: PC Linux
: --- normal
Target Milestone: ---
Assignee: Marek Safar
URL:
Depends on:
Blocks:
 
Reported: 2012-03-02 11:20 UTC by John Ruiz
Modified: 2012-03-02 13:33 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 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:
Status:
RESOLVED FIXED

Description John Ruiz 2012-03-02 11:20:18 UTC
I have an interface called IEventManager that contains the following:

/// <summary>
/// Publishes an event and provides an event handler to accept responses asynchronously. Responses must be sent by 
/// means of the <code>EventHandler.RespondTo(Event, Event)</code> method.
/// </summary>
/// <param name="event">The event to publish.</param>
/// <param name="handler">
/// The <see cref="T:IEventHandler"/> instance that will handle responses.
/// </param>
/// <returns>
/// An <see cref="SubscriptionToken"/> that should be passed to 
/// <code>EnvelopeHandler.Unsubscribe(SubscriptionToken)</code> after all expected responses are received.
/// </returns>
SubscriptionToken GetResponseTo(object ev, IEventHandler handler);

Compilation of this interface fails with an "Unexpected symbol '<'" exception.  It is complaining about the <see cref="T:IEventHandler"/> inside of the <param name="handler"> tag.

However, according to the mono documentation here: http://docs.go-mono.com/index.aspx?link=man:mdoc%285%29 the <param> tag is allowed to have a <see> tag inside of it.  In fact, the example contains a <see /> tag in it.
Comment 1 Marek Safar 2012-03-02 13:33:31 UTC
Already fixed in master