[Mono-list] Re: [Mono-hackers-list] Re: Patch for mcs

Atsushi Eno atsushi@ximian.com
Mon, 01 Nov 2004 07:29:02 +0900

Gaurav Vaish wrote:
> Hi Atushi,
>    Thanks for the pointer. I see that you do handle "/**/", setting
> "docAppend = true" and then probably that would invoke consuming.
>    I am not sure, but probably, unless you have:
> /**
>  * <summary>This would be handled</summary>
>  */
>   it would be discarded.

Mhm, I cannot understand what you meant. What is (and should not be?)
discarded? My patch handles usual "/** ... */" comments as well as
those comments.

>>       - having raw strings rather than XmlElement (learned
>>         from your patch ;-) It would also improve the code
>>         tip that Marek suggested
>    Well, that's what I am exactly looking for. My way of handling the
> documentation would be to gather the comments as raw elements, and
> register any warnings only in the end. (I safely assume that it may
> suck! ;-)

Actually why I prefered XmlElement instead of raw string was to handle
warnings embedded into the XML documentation. Having just a raw string
in MemberCore is not sufficient.

>    But the philosophy behind the whole is that mcsdoc does not
> compile. Nor does it give only xml but full html/chm etc. But yes..
> that's in advanced times. It's still in infancy.

When it comes to that you're just using the common markup to
csc /doc, why just not pipeline to ndoc(-console) or whatever?

>   My aim with mcsdoc is not to just get xml-style docs but the
> javadoc-"@" stylos also. :-) I remember, I wrote in one of my mails a
> year back, they are cheaper.

Well, such extensions should not be done with /doc switch. It should
be available in different switch name, for example /docx.

Atsushi Eno