Doxygen：如何引用函数，但带有参数值

Question

当我生成此类的文档时：

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。

考虑到这个讨论，它应该有效。为什么我没有获得超链接。我究竟做错了什么？

Answer 1

正如 ArturKink 所评论的，inhibitSaving(true)这不是一个有效的类型引用，只是inhibitSaving(bool)。

因此应该创建链接，如下所示：

\ref inhibitSaving(bool) "inhibitSaving(true)"

或者像：

\ref inhibitSaving "inhibitSaving(true)"