doxygen c ++虛擬函數和實現

Question

您如何評論doxygen c ++虛擬函數及其實現

有沒有一種簡單的方法可以將實現從鏈接到“接口”，還是建議您再次注釋虛擬函數的每個實現中的每個參數？

   class a
{
 public:

  /**
   * Cyclic read of data from Stack to host
   * @param address pointer to address object
   * @param data data to be transmitted
   * @param size size of data in bytes
   * @return transmitted number of bytes
   */
  virtual UINT32 DoSomething(ADDRESS *address, UINT_8 *data,
                                UINT32 size) = 0;
}

class b : public class a
{
  /**
   * Implementation of interface a - how to document? write everything again, or link somehow?
   * @param address pointer to address object
   * @param data data to be transmitted
   * @param size size of data in bytes
   * @return transmitted number of bytes
   */
  virtual UINT32 DoSomething(ADDRESS *address, UINT_8 *data,
                                UINT32 size) = 0;
}

Answer 1

如我的評論所述，例如

class b : public class a
{
 public:

  /**
   * Implementation of interface a - how to document? write everything again, or link somehow?
   *
   * \copydoc a::DoSomething
   */
  virtual UINT32 DoSomething(ADDRESS *address, UINT_8 *data,
                                UINT32 size) = 0;
};

或使用\\snippetdoc ：

class a
{
 public:

  /*
   [snip_a]
   Cyclic read of data from Stack to host
   @param address pointer to address object
   @param data data to be transmitted
   @param size size of data in bytes
   @return transmitted number of bytes
   [snip_a]
   */
  /**
   * \snippetdoc this snip_a
   */
  virtual UINT32 DoSomething(ADDRESS *address, UINT_8 *data,
                                UINT32 size) = 0;
};

class b : public class a
{
 public:

  /**
   * Implementation of interface a - how to document? write everything again, or link somehow?
   *
   * \snippetdoc this snip_a
   */
  virtual UINT32 DoSomething(ADDRESS *address, UINT_8 *data,
                                UINT32 size) = 0;
};

注意： [snip_a]在常規注釋塊中的位置！ 和缺少的星號（ * ）