What's the right way to reference a parameter in Doxygen?

前端 未结 3 1416
失恋的感觉
失恋的感觉 2021-02-01 00:27

I have the following Doxygen documentation for a function:

/**
  @brief Does interesting things

  @param[in]  pfirst The first parameter: a barrel full of monke         


        
3条回答
  •  误落风尘
    2021-02-01 01:14

    use the "#" symbol in front of the parameter you want to reference:

    #pfirst must have been previously passed through BarrelFiller()
    

    (in the doxygen manual)

提交回复
热议问题