[jtc] apidocs

[jean-frederic clere <jf...@fujitsu-siemens.com>]

Hi,

I am starting to prepare mod_jk to use scandoc to generate the code
documentation.

I have noted that mod_web uses include files as input but it seems more easy to
use also the c sources files.

Any comments?

Cheers

Jean-frederic

Re: [jtc] apidocs

["Pier P. Fumagalli" <pi...@betaversion.org>]

jean-frederic clere at jfrederic.clere@fujitsu-siemens.com wrote:
> 
> The scandoc we use is 0.12 does it make sense to update it to 0.14 (The
> lastest one).

Yeah... I believe my patches were incorporated in the main tree, so, +1,
give a shot to 0.14...

    Pier

Re: [jtc] apidocs

[jean-frederic clere <jf...@fujitsu-siemens.com>]

"Pier P. Fumagalli" wrote:
> 
> jean-frederic clere at jfrederic.clere@fujitsu-siemens.com wrote:
> 
> > Hi,
> >
> > I am starting to prepare mod_jk to use scandoc to generate the code
> > documentation.
> >
> > I have noted that mod_web uses include files as input but it seems more easy
> > to
> > use also the c sources files.
> >
> > Any comments?
> 
> The parsing in scandoc is pretty damn screwed... Try to see if it works, but
> I doubt that it will successfully parse all the sources. (On mod_webapp I
> use the headers since that's what they're doing in APR, and more
> specifically, because you don't actually care in which C file that function
> is defined, but more likely in which header, as you #include <somefile.h>).

Agreed but when someone writes/changes code there are more chances that comments
in the C sources file are created/updated than comments in a separe include. 

Scandoc parses without problems (well, without error messages) the
jakarta-tomcat-connectors/jk/native/common/*.h *.c.

But I have already one problem. @bug does not work... 

The scandoc we use is 0.12 does it make sense to update it to 0.14 (The lastest
one).

> 
> My 0.02 $
> 
>     Pier

Re: [jtc] apidocs

["Pier P. Fumagalli" <pi...@betaversion.org>]

jean-frederic clere at jfrederic.clere@fujitsu-siemens.com wrote:

> Hi,
> 
> I am starting to prepare mod_jk to use scandoc to generate the code
> documentation.
> 
> I have noted that mod_web uses include files as input but it seems more easy
> to
> use also the c sources files.
> 
> Any comments?

The parsing in scandoc is pretty damn screwed... Try to see if it works, but
I doubt that it will successfully parse all the sources. (On mod_webapp I
use the headers since that's what they're doing in APR, and more
specifically, because you don't actually care in which C file that function
is defined, but more likely in which header, as you #include <somefile.h>).

My 0.02 $

    Pier