[Mono-dev] [Mono-list] Using monodoce for non-official mono project

[Jonathan Pryor]

On Thu, 2008-04-03 at 12:45 +0200, Manuel de la Pena wrote:
> I'm in a developing group that is planning to release an opensource API
> that we have developed. We are looking in to different ways of
> documenting the code. We have come across monodoc and monodocer. Is it a
> tool that can just be used with official mono projects??

monodocer can be used against any .NET assembly.  It enforces a
"documentation outside of source" philosophy, though it can also import
any existing XML Documentation Comments you may have for your project:

	http://www.mono-project.com/Monodocer

Monodoc is a GUI to display documentation generated by monodocer.  It's
a Gtk# app, and I don't know if it runs on Windows.  (I suspect it
doesn't at this time, due to the use of GtkHtml, but once the Gecko or
WebKit HTML renderers are working a Windows port likely wouldn't be
difficult.)

There is also an ASP.NET app to display the documentation, though sadly
there is little documentation about how to set this up:

	http://anonsvn.mono-project.com/source/trunk/monodoc/engine/web/

Example site:
	http://www.go-mono.com/docs/

monodocs2html will generate a static set of HTML pages containing
documentation:

	http://www.mono-project.com/Generating_Documentation
	http://www.go-mono.com/docs/index.aspx?link=man:monodocs2html(1)
	http://www.go-mono.com/docs/index.aspx?link=man:mdoc-export-html(1)

Example output:
	http://www.jprl.com/Projects/mono-fuse/docs/
	http://anonsvn.mono-project.com/source/trunk/monodoc/tools/DocTest/html.expected/

See also:
	http://www.go-mono.com/docs/monodoc.ashx?link=man:mdoc(1)

> Is there any way
> to use it to document our API and upload the changes to our server?

Depends on what you use.  If you use monodocs2html, you just need to
rsync the directory trees and you're done.  The ASP.NET web app requires
that you Assemble your documentation into a .zip/.tree/.source set (with
mdassembler),  install that into $prefix/lib/monodoc/sources on your web
server, and (maybe - not sure) restart ASP.NET.

See:
	http://www.mono-project.com/Assembler

 - Jon