Re: [Lxr-developer] Code documentation

[Neil S. <ns...@ci...>]

> I couldn't actually find a doxygen page with a link to the lxr'd source
> code,

...no, neither could I, but they seem to have had the idea :-) ...

> but I'm sure there are many possibilites for doxygen and lxr to work
> together.

I agree.

> What I want to do is to understand the lxr source code and document it
using
> doxygen. A first step....

I can't help here, I'm not an LXR contributor - just now, at least. All I
can offer is moral support.

So good luck with it! I think LXR (it's probably a little late to rename =
it,
but it has uses far beyond browsing the Linux source) is a killer app for
developers on large projects.

Cheers,

Neil.

> Zubin
>
> -----Original Message-----
> From: Neil Salter [mailto:ns...@ci...]
> Sent: Tuesday, 12 June 2001 5:36 PM
> To: lxr...@li...
> Subject: Re: [Lxr-developer] Code documentation
>
>
> Hello,
>
> The guys here: http://unstable.elemental.com/mozilla/ had the idea of
cross
> linking between doxygen and LXR. I think this is a good idea. Currently
I'm
> using doxygen to document a (fairly large) source tree, and I plan to u=
se
> LXR on the same tree. I'd say it'd be pretty useful to be able to jump
from,
> say, a classname in LXR to the doxygen page for the class - and vice
versa.
> It could all be done manually by the user just now, but it might be wor=
th
> thinking about as potential future feature for incorporation into the
> software.
>
> Just my =A30.01.
>
> Cheers,
>
> Neil.
>
> ----- Original Message -----
> From: "Malcolm Box" <ma...@br...>
> To: <lxr...@li...>
> Sent: Tuesday, June 12, 2001 3:03 AM
> Subject: Re: [Lxr-developer] Code documentation
>
>
> > Hi Zubin,
> >
> > That would be excellent!  I've used Doxygen before, and it's a great
> > tool.  I wasn't aware that it supported Perl, but if it does then let=
's
> > go for it.
> >
> > As far as I'm concerned, any patch that improves comments or
> > documentation in any way will always be gladly accepted.
> >
> > Cheers,
> >
> > Malcolm
> >
> > Sethna, Zubin (RSA, Brisbane) wrote:
> >
> > >Hi folks
> > >
> > >How to people feel about adding Doxygen comments to the LXR source
code?
> > >Doxygen generates html pages from the comments you insert into the
source
> > >code. Just a header to each function describing what it does and its
> > >input/output? I would like to start this if I get the go ahead from =
u
> all.
> > >
> > >I'm a newbie to perl and I think it would ease the learning curve fo=
r
> people
> > >like me who wish to contribute code to this project.
> > >
> > >
> > >Regards
> > >
> > >
> > >
> > >Zubin
> > >
> > >
> > >_______________________________________________
> > >Lxr-developer mailing list
> > >Lxr...@li...
> > >http://lists.sourceforge.net/lists/listinfo/lxr-developer
> > >
> >
> >
> >
> > _______________________________________________
> > Lxr-developer mailing list
> > Lxr...@li...
> > http://lists.sourceforge.net/lists/listinfo/lxr-developer
>
>
> _______________________________________________
> Lxr-developer mailing list
> Lxr...@li...
> http://lists.sourceforge.net/lists/listinfo/lxr-developer
>
> _______________________________________________
> Lxr-developer mailing list
> Lxr...@li...
> http://lists.sourceforge.net/lists/listinfo/lxr-developer