[Mono-osx] How to display class/method descriptions during code completion?

Jonathan Pryor jonpryor at vt.edu
Mon Jan 3 13:27:06 EST 2011

On Jan 1, 2011, at 3:26 PM, Regan Sarwas wrote:
> I have started editing the summary tag in the xml doc files for some of the classes I am reviewing, and I would like to check the results in MonoDevelop before I submit.  How are these edits made available to MonoDevelop?

As Steve Lessard mentioned, you can provide a 'CSC /doc'-style XML file for your assembly, and MonoDevelop will read the XML.  You can also provide assembled monodoc documentation [0].

Assembled documentation (e.g. foo.zip, foo.tree, foo.source) should be placed into $prefix/lib/monodoc/sources.

Once installed, you can also view your documentation within monodoc (on Linux & OSX).

 - Jon

[0] http://www.mono-project.com/Generating_Documentation#Assemble_the_generated_Documentation

More information about the Mono-osx mailing list