[Mono-list] Computer-readable Mono documentation

Jonathan Pryor jonpryor at vt.edu
Mon Jan 24 10:32:02 EST 2011


On Jan 23, 2011, at 2:35 PM, Cauê Waneck wrote:
> I am finishing a C# target for haXe ( haxe.org ), and I need some way to automate the generation of externs.

I'm not entirely sure what this means...

> If there is a way to get all mono documentation ( it would be best if it contained info of what runtime version it is implemented (.net/mono versions) and if there is a .net counterpart ) in machine-readable format, it would save me a lot of time!

Several assemblies do have documentation and documentation "stubs" for some (but not all) assemblies.  They're in git, in mcs/class/*/Documentation/en, e.g.

	https://github.com/mono/mono/tree/master/mcs/class/corlib/Documentation/en

Documentation is stored in mdoc(5) format:

	http://www.go-mono.com/docs/index.aspx?link=man:mdoc(5)

I'm not sure if this counts as "machine readable" for you, but they're the only source of documentation that we have...

 - Jon



More information about the Mono-list mailing list