[Mono-devel-list] monodoc provider for doc comments
bmaurer at users.sourceforge.net
Tue Apr 6 21:31:19 EDT 2004
On Tue, 2004-04-06 at 20:19, Paul Thomas wrote:
> (By the way, does anyone know how soon mcs will support the /doc
> option, and how similar it will perform relative to the csc /doc
Atsushi is working on creating a patch for this.
> Will this work?
Yeah, it would go something like this.
> Does such a provider already exist? If not, is one planned? If so,
There are not concrete plans for such a provider.
> Is there an experienced provider
> writer out there willing to share his/her experience or advice? How
> much of an effort would you estimate writing such a provider to be
> (trivial, small, medium, large, huge)?
Writing a provider like the ecma one is a pretty big task. The current
ecma provider is very deeply tied into the system. Like joshua, I
recommend transforming the c# docs into the monodoc format. This way,
you get new benefits as we add them to the system (eg, formatting fixups
we make, etc). Of course, some features you wont be able to take
advantage of (like the beautiful editing system in MonoDoc which, sadly,
you miss out on).
Going with the approach you are suggesting has a pretty high tendency
towards code duplication, which is never really a good thing.
> Is there a standard for naming providers? The current provider names
> all seem to be 2-8 characters, all lower case, with no underlines or
> hypens. Is doccomm okay?
How about cscxml? i have no idea what doccomm is intended to stand for.
More information about the Mono-devel-list