(Not sure that this is the right category; Full .NET/Mono Frameworks may be equally appropriate.)
On May 28 2014, Miguel announced that the .NET BCL Documentation was available under a creative commons license, specifically cc4. That documentation is currently present in mono’s source tree, within a
Documentation directory for each assembly.
That works for now, but what of the future Core CLR effort? I do see some inline C# documentation comments, e.g. in System.Collections.Immutable, but I also see
<include/> doc comments, e.g. in XPath, with no corresponding
doc\XmlNodeOrder.uex file to import documentation from.
What would be nice is consensus around:
- Should Documentation be under the umbrella of the Core .NET Framework?
- If so, how should documentation be provided? Inline C# doc comments vs. relying upon
<include/>and storing the documentation in separate files. (Using separate files is my personal preference…)
- If using separate files, the XML schema for those files (normal
- It is my understanding that at present Microsoft uses a custom XML dialect for their BCL source, which was translated and imported into Mono’s source tree. This may or may not be a useful starting point.
- Guidelines on tooling to use, and inclusion of tooling into buildtools.
- Perhaps mdoc?