Thread: [Lxr-developer] Code documentation
Brought to you by:
ajlittoz
From: Sethna, Z. (R. Brisbane) <ZS...@rs...> - 2001-06-11 23:28:23
|
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 for people like me who wish to contribute code to this project. Regards Zubin |
From: Malcolm B. <ma...@br...> - 2001-06-12 02:07:12
|
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 for 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 > |
From: Neil S. <ns...@ci...> - 2001-06-12 07:36:34
|
Hello, The guys here: http://unstable.elemental.com/mozilla/ had the idea of cro= ss 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 fr= om, say, a classname in LXR to the doxygen page for the class - and vice vers= a. 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. 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 cod= e? > >Doxygen generates html pages from the comments you insert into the sou= rce > >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 for 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 |
From: Malcolm B. <ma...@br...> - 2001-06-12 09:55:09
|
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 |
From: Neil S. <ns...@ci...> - 2001-06-13 10:44:09
|
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. |
From: Rusty C. <rca...@te...> - 2001-06-13 14:47:00
|
"Neil Salter" <ns...@ci...> wrote: > Hi Malcom, > > ... > I'd also - humbly - suggest that replacing glimpse with a free engine should > be a higher priority ... I'm using an older glimpse version just because its free - what are the alternatives??? thanks! rc |
From: Neil S. <ns...@ci...> - 2001-06-13 15:17:04
|
I know mngosearch has been suggested before now: http://search.mnogo.ru/ ...as has htdig: http://www.htdig.org/ However, whilst trying to locate the mngo URL, I chanced across the following page which also lists a number of other free search/indexing engines: http://twiki.org/cgi-bin/view/Codev/SearchAttachments Cheers, Neil. ----- Original Message ----- From: "Rusty Carruth" <rca...@te...> To: <lxr...@li...> Cc: <ns...@ci...> Sent: Wednesday, June 13, 2001 3:43 PM Subject: Re[2]: [Lxr-developer] Code documentation > "Neil Salter" <ns...@ci...> wrote: > > Hi Malcom, > > > > ... > > I'd also - humbly - suggest that replacing glimpse with a free engine should > > be a higher priority ... > > I'm using an older glimpse version just because its free - what are the alternatives??? > > thanks! > > rc |
From: Per K. G. <pk...@ne...> - 2001-06-22 13:43:43
|
* Neil Salter | 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. Supporting documentation systems and bug tracking systems is something we have been thinking about. My personal opinion is to not tie LXR to any particular system, but provide general hooks that would make it straightforward to support more than one system. Besides from that I think it would be smarter to concentrate on getting the basic functionality in place before starting to add new features. But, this is an open source project, people are free to work on whatever they want. Per Kristian |