2017-02-01 2 views
1

값 방법 :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에 하이퍼 링크가 없습니다.

this discussion을 고려하면 효과가 있습니다. 하이퍼 링크를받지 못하는 이유는 무엇입니까? 내가 도대체 ​​뭘 잘못하고있는 겁니까?

+2

\ref inhibitSaving "inhibitSaving(true)" 토론을보고 작성해야합니다, 당신은 위의 쓴 예는 (사실이 유형의 값이 아닌) 디미트리가 제공 목록에 없습니다. 당신이 원하는 것은 \ ref inhibitSaving (bool) "inhibitSaving (true)"또는 \ ref inhibitSaving "inhibitSaving (true)"입니다. –

+0

@ArturKink : 당신 말이 맞아요. 평판을 얻으려면 답변으로 게시하고 싶을 수 있습니다. – jpo38

답변

0

ArturKink가 언급 한대로 inhibitSaving(true)은 유효한 유형의 참조가 아니며 inhibitSaving(bool)입니다.

그래서 링크가 \ref inhibitSaving(bool) "inhibitSaving(true)" 또는

관련 문제