Jonathan Pryor | 22 Feb 2010 22:44
Picon
Favicon
Gravatar

Re: monodoc --edit crashes on newly created doc

On Sun, 2010-02-21 at 14:28 -0500, Matthew Pirocchi wrote:
> I'm working on following this guide to getting started on documenting
> my code:
> http://www.mono-project.com/Generating_Documentation
> 
> 
> My code is divided into 4 assemblies, so I generated the documentation
> with these 4 commands:
> 
> 
> mdoc update -o cardinal-doc Cardinal.exe
> mdoc update -o cardinal-doc Cardinal.Core.dll
> mdoc update -o cardinal-doc Cardinal.Interface.dll
> mdoc update -o cardinal-doc Cardinal.Services.dll

Don't do that.

'cardinal-doc/index.xml' is supposed to contain all the types that are
within the assemblies you're documenting.  However, it is regenerated
each time 'mdoc' runs, and contains only those assemblies which are
being processed for that invocation.

Result: your second 'mdoc update' command causes index.xml to "lose" all
the types that were added by the first 'mdoc update', and the third
overwrites the second invocation, and...

There are two ways to handle multiple assemblies:

1. List all the assemblies at the same time, thus allowing index.xml to
properly contain all the types within the documentation index:
(Continue reading)


Gmane