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

Gaurav Vaish Gaurav Vaish <gaurav.vaish@gmail.com>
Tue, 2 Nov 2004 10:43:54 +0530

>        - To clarify what Gaurav want and need to incorporate to mcs
>          and what is the same, differences, and conflicts in our
>          patches (yes, it conflicts; at least there is
>          MemberCore.Documentation in different types.)


    c.Documentation = CreateMemberComment ("F:" + MakeName (c.MemberName));


    XmlElement CreateMemberComment (string fullyQualifiedName) { ... }

    The difference is here. I don't want XMLElement at all. I want:

    c.Documentation = xml_comment_buffer; // or xml_comment_buffer.ToString()

    Why do I need raw-string? Probably, I can't explain this right
now, but it will be more clear if you directly look at the javadoc
tool / implementation of xdoclet.

> I've put the patch here:
> http://primates.ximian.com/~atsushi/mcs-doc-patches/mcs-doc-20041102.diff
> and will post to the list when I finished cref handling.

    public XmlElement Documentation;

   My patches had:

   public string Documentation;

> No, it understands such markup (maybe you mean, comments without
> tags?). Having XmlElement does not matter here. It is just a
> cosmetic matter that we could just hold string and a few fields
> instead of XmlElement.

   Oh ok then. I didn't go much deep into the code that means. ;-)

> Do you intend to create another tool like javadoc?

   Precisely. No "/doc" or "/mcsdoc" switch. But like you have
"javac", "java" and "javadoc", I intend to have "mcs", "mono" and

> Am not sure /mcsdoc is good name which sounds like "it is the MCS
> documentation format" without common understanding. So what is
> the documentation format? (javadoc?) How does your patch fill
> your need?

   The patch feeds my NDoclet-Engine (ah, that's not a formal name).

   Basic infra (in very infancy) is at:


   Most of the code is what I moved from

   "csdoc/src/csdoc/MCSDoc" to "csdoc/src/mcsdoc/MCSDoc" and former
code is around a year old.

   The idea, as I said, is not just a documentation tool but a
documentation engine. And as such, I need the raw-comment.

   Still not clear? Hooh! I'll have to improve my English it seems :((


> Atsushi Eno

Happy Hacking,
Gaurav Vaish