[Mono-docs-list] Fwd: [Mono-winforms-list] Exception when using monodocer on System.Windows.Forms.dll

[Jonathan Pryor]

On Sun, 2006-12-17 at 09:50 +0100, latency wrote:
> as I said, I've managed to include the SWF documentation into monodoc. But 
> that would be a solution which is only available to me. But my intention was 
> it to find a way where SWF documentation would be shipped with monodoc 
> automatically. (Maybe I did not express myself clear enough in the last 
> mail.)

If you have an svn account, you can add the files at any time.
Otherwise, you need to wait until one of us has a chance to update svn.

This also requires updating the monodoc build process.  Currently it
uses monodoc/generator/updater.exe, while it needs to use
monodocer/tools/monodocer.exe, as monodocer.exe supports generics while
updater.exe doesn't.

This change is trivial.

What is less trivial is that we want to separate the .NET 1.1 docs from
the .NET 2.0 docs.

This is also trivial -- add ``-since:".NET 2.0"'' to the monodocer
command line, and any added types/members will get a <since/> element
added with the specified value.  If we assume that the previous docs
only contain 1.1 docs (and *all* of the 1.1 docs), then this works
fairly well.

This could all be done now, actually, but I had been holding off on
doing it as I wanted to change monodocer so that it could import the
ECMA 335 documentation, as ECMA 3rd Edition (and now 4th Edition)
contains documentation for many of the generic types/members, and we'd
like to make use of this.

However, as per discussion with miguel earlier last week, we currently
plan to always overwrite the existing docs with the new docs when
importing ECMA docs, so there is no reason to wait on updating the
monodoc/class docs for this new support.

Given this, I'll try to get updated docs committed to svn some time this
week, and work on the monodocer support later.

> The only way I can think of right now is adding the swf docs to the build 
> process of monodoc. But I don't know if this is possible and how this will 
> work with user contributions and so on since I'm not to familiar with the 
> whole thing.

This is correct, SWF would need to be added to the build process of
monodoc.  We really should make sure that all assemblies included with
mono are part of monodoc as well.

> Btw. I'm aware of the Assembler page in the wiki, I "wrote" it yesterday. But 
> could you please tell me where is the difference between mdassembler and 
> assembler?

mdassembler is a script which executes assembler.exe:

	#!/bin/sh

	prefix=/usr
	exec_prefix=${prefix}
	monodocdir=/usr/lib/monodoc

	exec /usr/bin/mono $monodocdir/assembler.exe "$@"

So it's easier for everyone to use.

 - Jon