2014-02-24 85 views
1

我剛剛意識到我可以在方法實現中編寫部分doxygen文檔,這似乎是一個非常好的方法來獲得準確的文檔!在doxygen輸出中避免換行

打擾我的是,我想避免寫在多行句子時斷行一個小東西:

/// Check if the pointer is not null, 
if(ptr !=) { 
    /// increment it 
    ptr++ 
    /// and perform other stupid task... 
    ... 
} 

這將產生3個型動物行,但我想它貼在一個。 有什麼想法?

回答

2

你要求的是不可能的,但是如果你想要這樣詳細的實現評論,讀者可能也想看到代碼,所以在這種情況下,我建議在配置文件中使用正常的//註釋並啓用INLINE_SOURCES

+0

我很高興有這個偉大的工具的首席開發人員的答案!感謝:-) –

+0

完全不同的問題:我最近問了github支持,他們是否有計劃在他們的平臺中更好地集成代碼文檔,並且他們對此感興趣。你不覺得這個想法有什麼好做的嗎? –