StackOverflow2013

Note that there are some explanatory texts on larger screens.

plurals

PO
text
Body
copied!<p>Gonzalo provided a good overview of the different modules.</p> <p>Since you also mentioned wanting to contribute to documentation, you'll want a few more pieces of information.</p> <p>First, Documentation is stored in XML files within <b>mcs/class/[assembly]/Documentation/</b>, e.g. <a href="http://anonsvn.mono-project.com/viewvc/trunk/mcs/class/corlib/Documentation" rel="nofollow noreferrer">mcs/class/corlib/Documentation</a>. The intent is to support multiple human languages (though only English is currently being worked on), so within <b>Documentation</b> is a language directory, usually <code>en</code>. Within <code>en</code> there are <code>ns-*.xml</code> files, e.g. <a href="http://anonsvn.mono-project.com/viewvc/trunk/mcs/class/corlib/Documentation/en/ns-System.xml" rel="nofollow noreferrer">mcs/class/corlib/Documentation/en/ns-System.xml</a> contains documentation for the <code>System</code> namespace. Also within <code>en</code> are "dotted namespace" directories, and within those are XML files, one per type, for example <a href="http://anonsvn.mono-project.com/viewvc/trunk/mcs/class/corlib/Documentation/en/System.Collections.Generic/IEnumerable%60.xml" rel="nofollow noreferrer">mcs/class/corlib/Documentation/en/System.Collections.Generic/IEnumerable`1.xml</a>.</p> <p>This is also outlined within the <a href="http://www.go-mono.com/docs/index.aspx?link=man:mdoc(5)" rel="nofollow noreferrer">mdoc(5)</a> documentation, in the <code>FILE/DIRECTORY STRUCTURE</code> section.</p> <p>Once you've found the documentation, you need to know the XML format, which is also described in the <a href="http://www.go-mono.com/docs/index.aspx?link=man:mdoc(5)" rel="nofollow noreferrer">mdoc(5)</a> documentation, in the <code>NamespaceName/TypeName.xml File Format</code> section. The XML dialect used is a variant of the <a href="http://www.ecma-international.org/publications/standards/Ecma-335.htm" rel="nofollow noreferrer">ECMA 335</a> <a href="http://www.ecma-international.org/publications/files/ECMA-ST/ECMA-335.zip" rel="nofollow noreferrer">XML documentation</a>, changed to have one file per type (instead of all types within a single monolithic file). This is also a superset of <a href="http://www.ecma-international.org/publications/files/ECMA-ST/Ecma-334.pdf" rel="nofollow noreferrer">C# XML documentation</a> (see <code>Annex E. Documentation Comments</code>, page 487).</p> <p>Finally, there's the question of adding new types/members to the <b>mcs/class/[assembly]/Documentation</b> directory. If you have Mono built, you can use the <code>doc-update</code> Makefile target. This will run the appropriate assembly through <a href="http://www.mono-project.com/Mdoc" rel="nofollow noreferrer">mdoc(1)</a> and update the appropriate files within the <b>Documentation</b> directory.</p> <p>If you have any other documentation questions, don't hesitate to ask on the <a href="http://lists.ximian.com/mailman/listinfo/mono-docs-list" rel="nofollow noreferrer">mono-docs-list</a> mailing list.</p>

Querying!

Guidance

An individual column

Larger individual text columns get their own page to allow for proper reading.

SQuiL has stopped working due to an internal error.

If you are curious you may find further information in the browser console, which is accessible through the devtools (F12).

Reload