CODEWITHSUNDEEP
htmlcdocumentationdoxygendoxywizard
audiFanatic
audiFanatic

Reputation: 2504

Greek Characters in Doxygen Documentation

I need to briefly discuss some math in my code documentation and I'd like to insert an actual Greek letter (lower-case lambda) rather than using the word "lambda." How can I do this in Doxygen? I've only dabbled in HTML with a 500-foot pole once before (I'm by no means a web programmer), so please forgive my ignorance. I've tried placing an &lambda in the documentation like the Doxygen user manual mentions, but it was unfortunately taken literally.

======================= Edit =======================================================

Here's the example as requested:

/**
 *     This function is used to fill an array with exponentially distributed
 *     random numbers. These numbers are distributed assuming rate parameter
 *     (λ) = 1.
 *
 *     The output vector can be modified for an arbitrary λ by dividing
 *     its contents by the desired value of λ (or, preferably for speed,
 *     multiplying its contents by the precomputed value of 1/λ) as
 *     shown in the histogram below.
 *     @image html exponential_histogram.png
 *
 *          @param size The size of the array to be filled.
 *
 *          @param vector The array which the user wants to fill with random
 *          values. Again, it should be of type @b float.
 *
 *          @param state The array which was initialized with the
 *          "DSP_urand32_init" function and maintained (but @b NEVER modified)
 *          by the user between subsequent calls to this function.
 */

Upvotes: 1

Views: 1422

Answers (2)

Guillermo Gutiérrez
Guillermo Gutiérrez

Reputation: 195

In version 1.9.1 you can encode symbols by simply use the html notation.

namespace sample
{
   /// @brief sample to show π
   class Show
   {

      public:
         /// @brief Show as as sample
         Show();
         ~Show();
   };
}

And it will generate π directly in your document

Upvotes: 0

yulian
yulian

Reputation: 1627

Here is the table of maintainer of various languages: Support for multiple languages

You can find your language and contact the maintainer (you'll see the address).

Upvotes: 0

Related Questions