Doxygen: как ссылаться на функцию, но со значениями аргументов
Когда я создаю документацию для этого класса:
class MyClass
{
/** Some description
* \param inhibit some description
*/
virtual void inhibitSaving( bool inhibit = true ) = 0;
/** \return true if @ref inhibitSaving with parameter set to true has been called previously */
virtual bool isSavinginhibited() const = 0;
};
isSavinginhibited
в описании есть гиперссылка на inhibitSaving
,
Однако, если я напишу описание как ниже:
/** \return true if @ref inhibitSaving(true) has been called previously */
virtual bool isSavinginhibited() const = 0;
isSavinginhibited
Описание не имеет гиперссылки на inhibitSaving
,
Учитывая это обсуждение, оно должно работать. Почему я не получаю гиперссылку. Что я делаю неправильно?
1 ответ
Решение
Как прокомментировал ArturKink, inhibitSaving(true)
не является допустимой ссылкой на тип, только inhibitSaving(bool)
является.
Так что ссылка должна быть создана \ref inhibitSaving(bool) "inhibitSaving(true)"
или же \ref inhibitSaving "inhibitSaving(true)"