Re: [Doxygen-users] Reference to values or evaluation

[<Ste...@in...>]

Hi Martin,
I was very intensively looking for the same feature you mentioned below. I also need it for customer documentation. However, it turned out to be not available yet.

I am also missing a feature like this.

-Stefan

-----Original Message-----
From: Martin Schäfer [mailto:m.s...@vo...]
Sent: Freitag, 31. Oktober 2008 11:22
To: dox...@li...
Subject: [Doxygen-users] Reference to values or evaluation

Hello,

I'm seeking the posibillity to place the value of a constant expression in my documentation.

Example:
Somewhere in your code are contant expressions like this

   /*!
    * \brief Level to switch on.
    */
   #define ON_LIMIT   100

Somewhere in your code are references to this contant

   ...
   if (level > ON_LIMIT) {
      /* switch on */
   }
   else {
      /* switch off */
   }
   ...

If you write a doxygen comment you can reference to the above contants name but not to the defined value.

   /*!
    :  ...
    *  If level is higher than ::ON_LIMIT it is switched on.
    :  ...
    */

This will result in the following output:

   ...
   If level is higher than ON_LIMIT it is switched on.
   ...

ON_LIMIT will be a link to the definition.  This may be suitable for a developer but not for a user who is reading a manual.  It would be nice if I could place the value instead the name of the constant in my documentation.

   /*!
    :  ...
    *  If level is higher than \eval(ON_LIMIT+1) it is switched on.
    :  ...
    */

The result should be

   ...
   If level is higher than 101 it is switched on.
   ...

Is there already a feature like this implemented in doxygen?
If not it would be nice to implement it. Keep in mind of other constant expressions like single fields of arrays, structures, list of structures, const definitions, etc.


Best regards
Martin

voltwerk electronics GmbH - Sitz der Gesellschaft: Hamburg - Amtsgericht Hamburg, HRB 100909
Geschäftsführung: Dirk Wiegmann

-------------------------------------------------------------------------
This SF.Net email is sponsored by the Moblin Your Move Developer's challenge
Build the coolest Linux based applications with Moblin SDK & win great prizes
Grand prize is a trip for two to an Open Source event anywhere in the world
http://moblin-contest.org/redirect.php?banner_id=100&url=/
_______________________________________________
Doxygen-users mailing list
Dox...@li...
https://lists.sourceforge.net/lists/listinfo/doxygen-users