Doxygen — Single Comment Block for Multiple Functions

前端 未结 2 1040
-上瘾入骨i
-上瘾入骨i 2021-01-11 16:02

Are you able to use a single commenting block to comment multiple functions in doxygen? Below is a simple example that does not work. Can I do something similar to get what

2条回答
  •  北海茫月
    2021-01-11 16:57

    I'm not sure about a single comment block, but a concise and easy way to do this is to use @copydoc (reference here), e.g:

    /**
     * @brief Brief description
     * @param aParam A parameter
     */
    void foo(int aParam) {}
    
    /**
     * @copydoc foo(int)
     */
    void bar(int aParam) {}
    

提交回复
热议问题