Re: [Lxr-developer] Code documentation

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

Hi Malcom,

Sorry about the delayed reply, I've been busy...

> 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?

Yes it looks a bit more complicated than I first thought. I'm afraid I'm not
familiar enough with the workings of LXR to make any sensible comment. I
would say that this is a feature that could be left for later, though.
Whilst useful, I'd say it's more important to get installation
documentation, and the core setup stuff working first.

I'd also - humbly - suggest that replacing glimpse with a free engine should
be a higher priority than a doxygen link-up: users can manually look up
doxygen classes etc. in just a few clicks.

I feel a bit cheeky asking for these things without putting in any effort to
deliver them, but I'm mailing in on the principle that any feedback is
useful.

Cheers,

Neil.