[Mono-list] Re: where to get the right documentation?

[Giuseppe Greco]

> I didn't see the begining of this topic so I may have moved slightly off
> topic.
>
>> Yes, but if I'm not wrong, XML files produced by monodoc cannot be
>> processed directly with ndoc... monodoc generates an XML file for
>> each corresponding *.cs file, while ndoc exprects a single XML file
>> for each assembly.
>>
>> The mono project does not embed the documentation into the code.
>> Instead, XML skeleton are generated with monodoc starting from the
>> compiled assemblies.
>
> I wasn't talking about monodoc. Your right both methods differ and are
> largely
> exclusive. I know the mono project doesn't embed the docs into the source,
> but
> GTK# isn't mono.
>
> The comment I was replying to was about getting (as a minimum) a skeleton
> description of the GTK# api as an aid to learning GTK#.
>
> Although monodoc is generally more flexibly than standard cs xml docs (and
> yes
> I would like to see a monodoc of the GTK# api) I didn't realise you had
> monodoc
> in mind. My memory is a bit hazy about monodoc, but can't it generate some
> skeleton xml files based on the source tree? If so, wouldn't that at least
> give
> you namespace/class/member lists?

... sorry, I just wanted to post a comment because I'm very interested
in documentation stuffs...

Yes, If you have the compiled assembly, you can generate the XML
skeleton with updater.exe, which is shipped with monodoc. updater.exe
generates an XML file for each class, so if you want to generate
documentation with ndoc, you have first to merge them (jerek has
already written such a tool).

After the skeleton XML files have been generated, you have just to
fill them out, and compile the whole with assembler.exe, which is
also shipped with monodoc.

I thinks it would be great if ndoc supported also the monodoc
paradigm, but of course, this is out of topic.

Gius_.


>
> Brian.
> _______________________________________________
> Mono-list maillist  -  Mono-list@lists.ximian.com
> http://lists.ximian.com/mailman/listinfo/mono-list
>


----------------------------------------
Giuseppe Greco

::agamura::

phone:  +41 (0)91 604 67 65
mobile: +41 (0)76 390 60 32
email:  giuseppe.greco@agamura.com
web:    www.agamura.com
----------------------------------------

----------------------------------------
Giuseppe Greco

::agamura::

phone:  +41 (0)91 604 67 65
mobile: +41 (0)76 390 60 32
email:  giuseppe.greco@agamura.com
web:    www.agamura.com
----------------------------------------