Mono basic docs from ECMA

[Amrein-Marie Christophe]

Hi

I hope that nobody has already asked this question:

Why not merge Mono documentation with original documentation from ECMA
CLILibraryTypes.xml file?

www.ecma-international.org/publications/files/ECMA-ST/ECMA-335.zip


_______________________________________________
Mono-docs-list maillist  -  Mono-docs-list@...
http://lists.ximian.com/mailman/listinfo/mono-docs-list

[Jonathan Pryor]

On Sat, 2009-04-04 at 18:39 +0200, Amrein-Marie Christophe wrote:
> I hope that nobody has already asked this question:
>
> Why not merge Mono documentation with original documentation from ECMA
> CLILibraryTypes.xml file?
>
> www.ecma-international.org/publications/files/ECMA-ST/ECMA-335.zip

Been there, done that, wrote the XML import support for mdoc-update:

http://www.go-mono.com/docs/index.aspx?tlink=10@man%3amdoc-update(1)

        -i, --import=FILE

        Import documentation found within FILE.

        FILE may contain either csc /doc XML or ECMA-335 XML.

The problem is, ECMA-335 doesn't contain documentation for very many
types -- only 331 types and 3797 members.  This sounds like a lot, until
you realize that mscorlib.dll has 1283 public types containing 2464
members, and System.Xml (also partially documented in ECMA-335) has 258
types with 4952 members, so the documentation included in ECMA-335 is
really just a drop in the proverbial bucket.

 - Jon


_______________________________________________
Mono-docs-list maillist  -  Mono-docs-list@...
http://lists.ximian.com/mailman/listinfo/mono-docs-list

[Amrein-Marie Christophe]

Le samedi 04 avril 2009 à 21:11 -0400, Jonathan Pryor a écrit :

> On Sat, 2009-04-04 at 18:39 +0200, Amrein-Marie Christophe wrote:
> > I hope that nobody has already asked this question:
> >
> > Why not merge Mono documentation with original documentation from ECMA
> > CLILibraryTypes.xml file?
> >
> > www.ecma-international.org/publications/files/ECMA-ST/ECMA-335.zip
>
> Been there, done that, wrote the XML import support for mdoc-update:
>
> http://www.go-mono.com/docs/index.aspx?tlink=10@man%3amdoc-update(1)
>
> -i, --import=FILE
>
> Import documentation found within FILE.
>
> FILE may contain either csc /doc XML or ECMA-335 XML.
>
> The problem is, ECMA-335 doesn't contain documentation for very many
> types -- only 331 types and 3797 members.  This sounds like a lot, until
> you realize that mscorlib.dll has 1283 public types containing 2464
> members, and System.Xml (also partially documented in ECMA-335) has 258
> types with 4952 members, so the documentation included in ECMA-335 is
> really just a drop in the proverbial bucket.
>
>  - Jon
>

A big part of that ECMA documentation is still not into monodoc

_______________________________________________
Mono-docs-list maillist  -  Mono-docs-list@...
http://lists.ximian.com/mailman/listinfo/mono-docs-list

[Miguel de Icaza-2]

Hello,

> A big part of that ECMA documentation is still not into monodoc

Since you have identified those areas, it would be very useful if you
shared that information with us.   Otherwise you are sending us on a
chase.

And considering that everyone is busy working on nice features for Mono,
work that requires to chase down statements like the above just
naturally fall into a lower priority.

_______________________________________________
Mono-docs-list maillist  -  Mono-docs-list@...
http://lists.ximian.com/mailman/listinfo/mono-docs-list