Re: [Lxr-developer] Code documentation

[Malcolm B. <ma...@br...>]

Hi Neil,

Neil Salter wrote:

>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 use
>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 worth
>thinking about as potential future feature for incorporation into the
>software.
>
I too have been considering this, since on the projects I'm working on 
we use both LXR and Doxygen, and their both served from the same tree. 
 Looking at that URL you gave, they've done the reverse thing, which is 
make Doxygen link to LXR, it looks like we need to do the LXR -> Doxygen 
linkage.

Here's what I think the features I'd like to see are:

1) From any LXR ident query, go to the associated doxygen documentation
2) Link to the doxygen file docs for each file in source view (or 
include at the top of the file)
3) Have the ident view display the doxygen usage/collaboration diagrams.

Somehow this all needs to be configurable - Doxygen puts out a static 
tree of files, so we need a way of mapping from an identifier to the 
right place in the tree, in the presence of multiple definitions of the 
same symbol.   What I mean is that there is unlikely to be a one to one 
mapping between an identifier and a piece of documentation - more like a 
fuzzy n-to-n match.

Anyone got any bright ideas how to make this work?

Cheers,

Malcolm