Греческие символы в документации по Doxygen
Мне нужно кратко обсудить некоторую математику в моей документации по коду, и я бы хотел вставить настоящую греческую букву (лямбда в нижнем регистре), а не использовать слово "лямбда". Как я могу сделать это в Doxygen? Я только однажды баловался HTML с 500-футовым шестом (я ни в коем случае не веб-программист), поэтому, пожалуйста, прости мое невежество. Я пытался разместить &lambda
в документации, как упоминается в руководстве пользователя Doxygen, но, к сожалению, оно было воспринято буквально.
======================= Редактировать ========================== =============================
Вот пример по запросу:
/**
* 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.
*/
2 ответа
В версии 1.9.1 вы можете кодировать символы, просто используя нотацию html.
namespace sample
{
/// @brief sample to show π
class Show
{
public:
/// @brief Show as as sample
Show();
~Show();
};
}
И он сгенерирует π прямо в вашем документе.
Вот таблица сопровождающих разных языков: Поддержка нескольких языков
Вы можете найти свой язык и связаться с сопровождающим (вы увидите адрес).