Thread: RE: [Doxygen-users] Customizing look in Doxygen
Brought to you by:
dimitri
From: CHUVALA, K. G. (JSC-D. (USA) <kei...@js...> - 2001-07-12 20:28:01
|
> From: joe bester [mailto:be...@mc...] > For example, we prefer to have functions displayed like this: > > return_type > function_name( > argument_type1 argument_name1, > argument_type2 argument_name2) I'd certainly welcome this addition. Like Joe, our team likes to use lengthy descriptive identifier names (vestiges of a sordid past working in COBOL, perhaps?) The configuration option idea is a good one, too; no sense forcing everyone to do things the RIGHT way, er, I mean MY way <g>. kgc ______________________________________ Keith G. Chuvala Space Operations Computing (SpOC) Team Johnson Space Center Houston, Texas, USA |
From: Don M. <dmc...@In...> - 2001-07-13 00:39:42
|
>For example, we prefer to have functions displayed like this: > >return_type >function_name( > argument_type1 argument_name1, > argument_type2 argument_name2) > >Rather than doxygen's default > >return_type function_name(argument_type1 argument_name1, argument_type2, >argument_name2) I, for one, would *love* to have doxygen show functions like that. I encourage you to submit that patch, but it probably should have a config option, since other users are accustomed to the old style. Thanks, Don McClimans |
From: Christoph K. <ko...@in...> - 2001-07-13 07:23:22
|
be...@mc... said: > If I were to submit a patch to do this sort of formattting, would it > be accepted? Perhaps if I wrapped it in a configuration option? I certainly second your proposal. Dimitri, what do you think? Cheers, Christoph |
From: Moshe K. <Kr...@Pa...> - 2001-07-15 09:04:48
|
Our team would definitely prefer the proposed layout. Moshe -----Original Message----- From: Christoph Koegl [mailto:ko...@in...] Sent: Friday, July 13, 2001 9:21 AM To: dox...@li... Subject: Re: [Doxygen-users] Customizing look in Doxygen be...@mc... said: > If I were to submit a patch to do this sort of formattting, would it > be accepted? Perhaps if I wrapped it in a configuration option? I certainly second your proposal. Dimitri, what do you think? Cheers, Christoph _______________________________________________ Doxygen-users mailing list Dox...@li... http://lists.sourceforge.net/lists/listinfo/doxygen-users |
From: Wagner, V. <VW...@se...> - 2001-07-16 14:19:27
|
You must be talking about the summary info, not the detailed info, right?? -----Original Message----- From: Joh...@ub... [mailto:Joh...@ub...] Sent: Monday, 2001 July 16 09:18 To: dox...@li... Subject: [Doxygen-users] Customizing look in Doxygen Dimitri / Joe Are the CR's (carriage returns) that was given in the example meaningful ? If so then this is not the format that doxygen produces in version 1.2.8.1 . Joe's Example > return_type > function_name( > argument_type1 argument_name1, > argument_type2 argument_name2) > I'm using doxygen 1.2.8.1 and the sort of HTML format for class members I'm getting is ... <tr> <td >RETURN_TYPE</td> <td>METHOD_NAME (ARGUMENT_1, ARGUMENT_2)</td> </tr> If the CR's in the example Joe gave were meaningful then perhaps Joe is suggesting something where the args are in separate cells on different rows in the HTML table ie a format more like .... <tr> <td>RETURN_TYPE</td> <td> </td> </tr> <tr> <td>METHOD_NAME</td> <td>(ARGUMENT_1</td> </tr> <tr> <td> </td> <td>ARGUMENT_2)</td> </tr> I have the same problem as Joe (ie "rather long function names and argument types") and the 1.2.1.8 format of HTML documentation as shown above is pretty unreadable. Joe's suggestion might help us with our common specific problem however this mail chain make me wonder if it would be preferable to have a more general solution - one that would allow personalisation of the formatting algorithm by for example an optional runtime plugin (ie on unix a .so file or NT would use a .dll file - dunno what other platforms offer for this sort of thing). This approach might help avoid a proliferation of compiler and runtime switches for other formats that users might wish to define. JL This transmission may contain information that is privileged, confidential and exempt from disclosure under applicable law. If you are not the intended recipient, you are hereby notified that any disclosure, copying, distribution, or use of the information contained herein (including any reliance thereon) is STRICTLY PROHIBITED. If you received this transmission in error, please immediately contact the sender and destroy the material in its entirety, whether in electronic or hard copy format. Thank you |
From: joe b. <be...@mc...> - 2001-07-16 16:37:01
|
From my perspective, I was first planning on looking at the detailed description and then look at the summary info. The problem that I'm seeing is that the table becomes very wide (some table renderers seem to not like to wrap tables) which throws off the rendering of other page elements. Things which should be centered (horizontally) are not visible on the page unless I use the brower's scroll bars. I'd like to have the summary description match the layout of the detailed descriptions, but that's a less high priority for me. I would imagine the longer-term solution would be based on the xml generator which is being working on. joe On Mon, Jul 16, 2001 at 10:19:19AM -0400, Wagner, Victor wrote: > You must be talking about the summary info, not the detailed info, right?? > > -----Original Message----- > From: Joh...@ub... [mailto:Joh...@ub...] > Sent: Monday, 2001 July 16 09:18 > To: dox...@li... > Subject: [Doxygen-users] Customizing look in Doxygen > > > Dimitri / Joe > > Are the CR's (carriage returns) that was given in the example > meaningful ? > If so then this is not the format that doxygen produces in version > 1.2.8.1 . > > Joe's Example > > return_type > > function_name( > > argument_type1 argument_name1, > > argument_type2 argument_name2) > > > > I'm using doxygen 1.2.8.1 and the sort of HTML format for class > members I'm getting is ... > > <tr> > <td >RETURN_TYPE</td> > <td>METHOD_NAME (ARGUMENT_1, ARGUMENT_2)</td> > </tr> > > If the CR's in the example Joe gave were meaningful then perhaps Joe is > suggesting something where the args are in separate cells on different > rows in the HTML table ie a format more like .... > > <tr> > <td>RETURN_TYPE</td> > <td> </td> > </tr> > <tr> > <td>METHOD_NAME</td> > <td>(ARGUMENT_1</td> > </tr> > <tr> > <td> </td> > <td>ARGUMENT_2)</td> > </tr> > > > I have the same problem as Joe (ie "rather long function names and > argument types") and the 1.2.1.8 format of HTML documentation as shown > above is pretty unreadable. > > Joe's suggestion might help us with our common specific problem however > this mail chain make me wonder if it would be preferable to have a more > general solution - one that would allow personalisation of the > formatting algorithm by for example an optional runtime plugin (ie on > unix a .so file or NT would use a .dll file - dunno what other > platforms offer for this sort of thing). This approach might help avoid > a proliferation of compiler and runtime switches for other formats that > users might wish to define. > > JL > > > > This transmission may contain information that is privileged, confidential > and exempt from disclosure under applicable law. > If you are not the intended recipient, you are hereby notified that any > disclosure, copying, distribution, or use of the information contained > herein (including any reliance thereon) is STRICTLY PROHIBITED. > If you received this transmission in error, please immediately contact the > sender and destroy the material in its entirety, whether in electronic or > hard copy format. > Thank you > > > > _______________________________________________ > Doxygen-users mailing list > Dox...@li... > http://lists.sourceforge.net/lists/listinfo/doxygen-users > -- Joseph Bester Phone: (630) 252-1496 Mathematics & Computer Science Fax: (630) 252-5986 Argonne National Laboratory Argonne, IL 60439 Email: be...@mc... |