Re: [E-devel] Ecore Docs

[Carsten H. (T. R. <ra...@ra...>]

On Sun, 25 Apr 2004 12:38:53 +1000 Nicholas Curran <qu...@bi...>
babbled:

> I noticed that some help with documentation is needed, so I started

aah oh most certainly! :)

> poking around the documentation generation code in Ecore.  I have been
> able to make doxygen generate a proper file list for the Ecore

oh MUCH nicer! :)

> documentation.  Instead of attributing all functions to the file
> ecore.c, functions can now be attributed to the header file in which
> they are prototyped.

nice nice :)

> A copy of the newly generated documentation can be downloaded from
> http://home.bigblue.net.au/quasar/ecore_docs.tar.gz. The patch to do
> this from the source is attached, if you are interested in using it in
> Ecore.

tested. done. looks nicer :)

> What the patch does:
>  - Stops gendoc from creating ecore.c.
>  - Tells doxygen (through the Doxyfile) to use ecore.c.in and the source
>    files in the src/lib directory (searching recursively) to generate
>    the documentation.
>  - Removes the @file statement from ecore.c.in, to prevent it appearing
>    in the file list.
>  - Adds @file and @brief statements to the public header files.
> 
> You still need to run 'make' before you can generate the docs with
> gendoc, as some of the header files (with their embedded doxygen
> statements) are created at compile time.
> 
> If I was to write documentation for Ecore, who could I ask stupid
> questions about the code, and to whom could I send any patches I
> created?  Would this list be appropriate?

me, xcomp, rbdpgn, tillman, rephorm, handyande and others... actually - stop by
#develop on irc.freenode.net - thats where the devel talk mostly happens :)

> I hope you find this patch useful.

yup yup. in cvs. now your next mail! :)

> Regards,
> Nicholas
> 


-- 
------------- Codito, ergo sum - "I code, therefore I am" --------------
The Rasterman (Carsten Haitzler)    ra...@ra...
熊耳 - 車君 (数田)                  ra...@de...
Tokyo, Japan (東京 日本)