You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@httpd.apache.org by Neale Ranns <ne...@ranns.org> on 2005/08/19 16:55:19 UTC
Doxygen
hi,
Over the past few days i've been reading around the source code and
improving the doxygen documentation. You can see the results here.
http://www.ranns.org/~ndrr/apache2/dox/html/index.html
Essentially what i have done is:
1) change all the @package (since these generate "Namespaces") to
@defgroup (which produces the grouping in the "Modules" page)
2) Added lots more @defgroup to get the module grouping on the
"Modules" page
3) Add a @file and @brief to each header file to improve the "File
List" page
4) Did some improvements to function and struct declarations; though by
no means all. There is a long way to go.
5) lastly i changed the doxygen.conf file:
a) to make the output searchable
b) to extract everything (otherwise the undocumented stuff is left out)
c) added a hack so the CORE_PRIVATE stuff is included
d) fixed the STRIP_FROM_PATH problem, by setting it to
"STRIP_FROM_PATH=" which implies, the directory from which doxygen is
run. It is possible to do with autoconf but more complicated.
comments always welcome :)
thanks
neale
Re: Doxygen
Posted by Ian Holsman <li...@holsman.net>.
Hi Neale.
I'll go through and review the patch today.
I'll try to get it commited in a couple of hours.
Neale Ranns wrote:
> Sander,
>
> I put a patch here (http://www.ranns.org/~ndrr/apache2/), it's kinda big
> to be emailing to all. There is also a tar ball there of the html files
> if anyone would like a copy.
> i am working from an up to date version of the svn trunk.
>
> thnaks
> neale
>
> On Fri, 2005-08-19 at 19:05, Sander Temme wrote:
>> Hi Neale,
>>
>> On Aug 19, 2005, at 7:55 AM, Neale Ranns wrote:
>>
>>> Over the past few days i've been reading around the source code and
>>> improving the doxygen documentation. You can see the results here.
>>>
>>> http://www.ranns.org/~ndrr/apache2/dox/html/index.html
>> Very cool. Could you produce a patch using diff -u? What version of
>> the source code are you working with?
>>
>> Thanks,
>>
>> Sander
>>
>>> Essentially what i have done is:
>>> 1) change all the @package (since these generate "Namespaces") to
>>> @defgroup (which produces the grouping in the "Modules" page)
>>> 2) Added lots more @defgroup to get the module grouping on the
>>> "Modules" page
>>> 3) Add a @file and @brief to each header file to improve the "File
>>> List" page
>>> 4) Did some improvements to function and struct declarations;
>>> though by
>>> no means all. There is a long way to go.
>>> 5) lastly i changed the doxygen.conf file:
>>> a) to make the output searchable
>>> b) to extract everything (otherwise the undocumented stuff is
>>> left out)
>>> c) added a hack so the CORE_PRIVATE stuff is included
>>> d) fixed the STRIP_FROM_PATH problem, by setting it to
>>> "STRIP_FROM_PATH=" which implies, the directory from which doxygen is
>>> run. It is possible to do with autoconf but more complicated.
>>>
>>> comments always welcome :)
>>>
>>> thanks
>>> neale
>>>
>
Re: Doxygen
Posted by Neale Ranns <ne...@ranns.org>.
Sander,
I put a patch here (http://www.ranns.org/~ndrr/apache2/), it's kinda big
to be emailing to all. There is also a tar ball there of the html files
if anyone would like a copy.
i am working from an up to date version of the svn trunk.
thnaks
neale
On Fri, 2005-08-19 at 19:05, Sander Temme wrote:
> Hi Neale,
>
> On Aug 19, 2005, at 7:55 AM, Neale Ranns wrote:
>
> > Over the past few days i've been reading around the source code and
> > improving the doxygen documentation. You can see the results here.
> >
> > http://www.ranns.org/~ndrr/apache2/dox/html/index.html
>
> Very cool. Could you produce a patch using diff -u? What version of
> the source code are you working with?
>
> Thanks,
>
> Sander
>
> > Essentially what i have done is:
> > 1) change all the @package (since these generate "Namespaces") to
> > @defgroup (which produces the grouping in the "Modules" page)
> > 2) Added lots more @defgroup to get the module grouping on the
> > "Modules" page
> > 3) Add a @file and @brief to each header file to improve the "File
> > List" page
> > 4) Did some improvements to function and struct declarations;
> > though by
> > no means all. There is a long way to go.
> > 5) lastly i changed the doxygen.conf file:
> > a) to make the output searchable
> > b) to extract everything (otherwise the undocumented stuff is
> > left out)
> > c) added a hack so the CORE_PRIVATE stuff is included
> > d) fixed the STRIP_FROM_PATH problem, by setting it to
> > "STRIP_FROM_PATH=" which implies, the directory from which doxygen is
> > run. It is possible to do with autoconf but more complicated.
> >
> > comments always welcome :)
> >
> > thanks
> > neale
> >
>
Re: Doxygen
Posted by Sander Temme <sa...@temme.net>.
Hi Neale,
On Aug 19, 2005, at 7:55 AM, Neale Ranns wrote:
> Over the past few days i've been reading around the source code and
> improving the doxygen documentation. You can see the results here.
>
> http://www.ranns.org/~ndrr/apache2/dox/html/index.html
Very cool. Could you produce a patch using diff -u? What version of
the source code are you working with?
Thanks,
Sander
> Essentially what i have done is:
> 1) change all the @package (since these generate "Namespaces") to
> @defgroup (which produces the grouping in the "Modules" page)
> 2) Added lots more @defgroup to get the module grouping on the
> "Modules" page
> 3) Add a @file and @brief to each header file to improve the "File
> List" page
> 4) Did some improvements to function and struct declarations;
> though by
> no means all. There is a long way to go.
> 5) lastly i changed the doxygen.conf file:
> a) to make the output searchable
> b) to extract everything (otherwise the undocumented stuff is
> left out)
> c) added a hack so the CORE_PRIVATE stuff is included
> d) fixed the STRIP_FROM_PATH problem, by setting it to
> "STRIP_FROM_PATH=" which implies, the directory from which doxygen is
> run. It is possible to do with autoconf but more complicated.
>
> comments always welcome :)
>
> thanks
> neale
>
--
sander@temme.net http://www.temme.net/sander/
PGP FP: 51B4 8727 466A 0BC3 69F4 B7B8 B2BE BC40 1529 24AF