From Mono

Monodoc browser editing

Editing from inside the Monodoc browser is simple. You have to navigate through the documentation and find where is the label To be added or Documentation for this section has not yet been entered and click on the [Edit] link near it (be sure the Editing option in the Edit menu is set or the [Edit] links won't be showed).

After clicking on an [Edit] link, monodoc will show an aspect similar to this one:

Where you can see the window is divided in two panels. The upper panel is where you type the XML Documentation code. Some buttons in the middle will help you with the most important tags. In the lower panel you can see a preview of the documentation as it is being typed. Finally, at the lowest part of the window you can see three buttons, Close for canceling the actual editing, Save for saving the changes and Restore to remove all your changes and restore the node as it was originally.

Writing XML Documentation

See the mdoc(5) (http://www.go-mono.org/docs/monodoc.ashx?link=man:mdoc(5)) man page for more details about monodoc XML file format.

The following tags can be used inside the <summary> and <remarks> sections of your documentation.

 <para> </para> 

Used to separate paragraphs.

 <paramref name="param_name"/> 

Used to reference a formal parameter to a function.

 <see cref="destination"/> 

Use this to create a link in your documentation to the sections for types, namespaces, methods, etc. where destination has one of the following formats:

• N:MyLibrary (to link to a namespace)
• T:MyLibrary.MyType (to link to a type)
• C:MyLibrary.MyType(System.String) (to link to a constructor)
  • Constructor links may also be written as: M:MyLibrary.MyType.#ctor(System.String)
• M:MyLibrary.MyType.MethodName(System.String,MyLibray.MyOtherType) (to link to a method; for ref and out parameters, add an & to the end of the type name)
• P:MyLibrary.MyType.IsDefined (to link to a property)
• F:MyLibrary.MyType.COUNTER (to link to a field)
• E:MyLibrary.MyType.OnChange (to link to an event)

So your links might look like:

<see cref="M:MyLibrary.MyType.MethodName(System.String,MyLibray.MyOtherType)"/>

 <see langword="keyword"/> 

Use this to link to a keyword in the C# language, for example to link to `true', do:

<see langword="true"/>

 <example> ... </example> 

Use example to insert an example. The example can contain explanatory text and code.

 <code lang="C#">.. </code> 

Use this to provide a sample C# program, typically used within the <example> tags. When providing examples, try to provide a full example, we would like to be able to have a button to compile and run samples embedded into the documentation, or pop up an editor to let the user play with the sample. You can link to an example like this:

<code lang="C#" source="file.cs"> </code>

When the source attribute is provided, the contents of the file file.cs will be inserted within the <code/> element by monodocer or mdoc-update the next time they are run. file.cs MUST be located in the base directory of the XML documentation, i.e. the monodoc -path or mdoc-update --out directory. file.cs may contain relative directory information as well, e.g. <code lang="C#" source="examples/file.cs" />.

 <list type="bullet"> </list> 

Use this to create lists. Lists contains <item> elements which have to contain <term> containers.

 <list type="table"> </lits>
<listheader>
<term>YOUR FIRST COLUMN</term>
<description>YOUR DESCRIPTION</description>
</listheader>

For two-column tables. Inside use:

 <item>
<term>First</term>
<description>First description</description>
</item> <item>
<term>Second</term> <description>Second descirption</description>
</item>