Doxygen: Как ссылаться на функцию, но с аргументами значения

Когда я генерировать документацию для этого класса: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 «s описание имеет гиперссылку на inhibitSaving.

Однако, если я пишу описание, как показано ниже:

/** \return true if @ref inhibitSaving(true) has been called previously */ 
virtual bool isSavinginhibited() const = 0;

isSavinginhibited «s описание не имеет гиперссылки на inhibitSaving.

Учитывая, что this discussion, он должен работать. Почему я не получаю гиперссылку. Что я делаю не так?

источник

2017-02-01 jpo38

Глядя на обсуждение, пример вы написали выше, не в списке Dimitri дает (правда, не относится к типу его значение). Кажется, что вы хотите \ ref inhibitSaving (bool) "inhibitSaving (true)" или \ ref inhibitSaving "inhibitSaving (true)" –

@ArturKink: Вы правы, это работает. Вы можете опубликовать это как ответ, чтобы получить заслуженную репутацию. – jpo38

Как комментирует ArturKink, inhibitSaving(true) не является допустимым типом ссылки, только inhibitSaving(bool) есть.

Так ссылка должна быть создана \ref inhibitSaving(bool) "inhibitSaving(true)" или \ref inhibitSaving "inhibitSaving(true)"

источник

2017-02-03 06:59:15 jpo38

Doxygen: Как ссылаться на функцию, но с аргументами значения

ответ

Смежные вопросы