doxygen-users

[Doxygen-users] Highlighted parameter names in function descriptions

[<Car...@no...>]

Hi,

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? 

Regards,
Carlos

Re:[Doxygen-users] Highlighted parameter names in function descriptions

[Philippe L. <Ph...@gm...>]

> 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

Re:[Doxygen-users] Highlighted parameter names in function descriptions

[Philippe L. <Ph...@gm...>]

Additional note:

If you meant that Doxygen should automatically highlight parameters names in
the descriptions, I don't think this is a good idea..

What if we have parameters name that are simple English (or the language
used in the doc) words? There will be false hits if the description mixes these
words with the parameter names.
You can object that your project always use compound names, but I still
think it is better to explicitely mark these parameters. Plus it gives you
control, you can eg. use @a for 'in' parameters, and @p for 'out' ones.

Regards.

-- 
--=#=--=#=--=#=--=#=--=#=--=#=--=#=--=#=--=#=--
Philippe Lhoste (Paris -- France)
Professional programmer and amateur artist
http://jove.prohosting.com/~philho/
--=#=--=#=--=#=--=#=--=#=--=#=--=#=--=#=--=#=--

Sent through GMX FreeMail - http://www.gmx.net