Minor issue with xml comments with embedded brackets

This forum is meant for questions and discussions about the X# language and tools
Post Reply
steveferrandino
Posts: 33
Joined: Tue Jan 05, 2016 8:00 pm

Minor issue with xml comments with embedded brackets

Post by steveferrandino »

Hi,

Hi,

the XML comments spec says to use ≤ and ≥ to escape < and >, respectively

so an xml comment like ≤string≥{"1","2","3","4"} should result in <string>{"1","2","3","4"}

the xml comments file throws <!--  Badly formed XML comment ignored for member ... -->

You're also supposed to be able to use cref="{string}" and the curlies get converted to brackets but that just includes the literal cref in the output

Thanks,
​​​​​​​SteveF
 
User avatar
robert
Posts: 4352
Joined: Fri Aug 21, 2015 10:57 am
Location: Netherlands

Minor issue with xml comments with embedded brackets

Post by robert »

Steve,
the correct codes are < and >
(Less Than, Greater Than)

Robert
XSharp Development Team
The Netherlands
robert@xsharp.eu
steveferrandino
Posts: 33
Joined: Tue Jan 05, 2016 8:00 pm

Minor issue with xml comments with embedded brackets

Post by steveferrandino »

Ugh. So Sorry

Thanks!
steveferrandino
Posts: 33
Joined: Tue Jan 05, 2016 8:00 pm

Minor issue with xml comments with embedded brackets

Post by steveferrandino »

still working on the xml comments and hit a snag. building an exe adds this to the xml file:
<member name="M:<Module>.$AppInit">
<summary>Compiler generated helper method.</summary>
</member>
<member name="M:<Module>.$AppExit">
<summary>Compiler generated helper method.</summary>
</member>

Sandcastle dies because of the brackets around Module

SteveF
User avatar
robert
Posts: 4352
Joined: Fri Aug 21, 2015 10:57 am
Location: Netherlands

Minor issue with xml comments with embedded brackets

Post by robert »

Steve,
I will look into this asap

Robert
XSharp Development Team
The Netherlands
robert@xsharp.eu
steveferrandino
Posts: 33
Joined: Tue Jan 05, 2016 8:00 pm

Minor issue with xml comments with embedded brackets

Post by steveferrandino »

if i hand edit the xml to be <Module> it works
Post Reply