RE: [Doxygen-users] Highlighted parameter names in function descr iptions
Brought to you by:
dimitri
From: <Car...@no...> - 2001-12-10 07:20:54
|
Hi, I understand it would not be most people's choice but I would hardly describe it as a "show stopper" because: - This behavior would be controlled by an option in the configuration file. It would be off by default. - Depending on your naming conventions you might not get these "false hits". Now, if you want to point out that there's possibly too many options already and that this would probably be handled better as a plugin or a post-process (on the XML output perhaps), then I would have to agree with you. Regards, Carlos -----Original Message----- From: ext Victor A. Wagner, Jr. [mailto:va...@ru...] Sent: 07. December 2001 14:53 To: Guerreiro Carlos (NRC/Helsinki) Subject: RE: [Doxygen-users] Highlighted parameter names in function descr iptions the point that there would be "false hits" when arguments are normal (maybe even common) words in the describing language is a "show stopper", IMO. no matter how "convenient' it might be for _your_ case, it would certainly adversely impact others. At Friday 2001/12/07 05:43, you wrote: >Thanks for the suggestion. >I'm aware of this possibility but I would really prefer this to be done >automatically be Doxygen, without any "markup". >Has this feature been request by someone before? I couldn't find it in the >wishlist in www.doxygen.org. > >Regards, >Carlos > > >-----Original Message----- >From: ext Philippe Lhoste [mailto:Ph...@gm...] >Sent: 07. December 2001 12:26 >To: dox...@li... >Subject: Re:[Doxygen-users] Highlighted parameter names in function >descriptions > > > > We have started using Doxygen 1.2.12 (on a Linux box) for a small project > > here. > > We are generally very pleased with Doxygen's output. > > There's a small improvement I would like to propose though: > > > > - In the descriptions generated for functions and methods it would be nice > > to have the parameter names highlighted in some way (bold, colors, etc). > > > > It could be that there is some way of achieving this with some option in >the > > configuration file but after searching for this is the project manual I > > found none. Any ideas? > >If, in the description of the function/method, you precede the parameter >name by \a or @a (depending on the style you choose), its name will be >italicized (with the <em> tag). >You can change the stylesheet to modify the color or other apparence. >Note: this is the way recommanded by the manual, but you can also use @b >(bold), @c (typewritter), @e or @em (italics, same as @a, but the later have >a >better structural meaning), @p (roughly same as @a, but use typewritter font >as @c). >See the Commands reference for more informations. > >Regards. > >-- >--=#=--=#=--=#=--=#=--=#=--=#=--=#=--=#=--=#=-- >Philippe Lhoste (Paris -- France) >Professional programmer and amateur artist >http://jove.prohosting.com/~philho/ >--=#=--=#=--=#=--=#=--=#=--=#=--=#=--=#=--=#=-- > >Sent through GMX FreeMail - http://www.gmx.net > > >_______________________________________________ >Doxygen-users mailing list >Dox...@li... >https://lists.sourceforge.net/lists/listinfo/doxygen-users > >_______________________________________________ >Doxygen-users mailing list >Dox...@li... >https://lists.sourceforge.net/lists/listinfo/doxygen-users Victor A. Wagner Jr. http://rudbek.com PGP RSA fingerprint = 4D20 EBF6 0101 B069 3817 8DBF C846 E47A PGP D-H fingerprint = 98BC 65E3 1A19 43EC 3908 65B9 F755 E6F4 63BB 9D93 The five most dangerous words in the English language: "There oughta be a law" |