Question

以下列格式编写文档后：

/*! \class Bishop
 *  \brief Child class of Figure representing Bishop.
 *
 *  \fn Bishop::Bishop()
 *  \brief Defualt constructor.
 *  \param [in] color Which player owns this chess piece.
 *
 *  \fn virtual bool Bishop::CanMoveTo(const Board * board, int x, int y) const
 *  \brief Whether currently selected chess piece can move to coordinates given in parameters.
 *  \param[in] board Chess board figure belongs to.
 *  \param[in] x X coordinate to move to.
 *  \param[in] y Y coordinate to move to. 
 *  \return True if such move is possible, else false.
 *
 *  \fn virtual string Bishop::Description() const
 *  \brief Name of chess piece.
 *  \return "bishop".
 */

class Bishop : public Figure
{
    public:
        Bishop(color_t color);
        virtual bool CanMoveTo(const Board * board, int x, int y) const;
        virtual std::string Description() const;
};

我从doxygen得到以下错误：

bishop.h:14: warning: The following parameters of Bishop::CanMoveTo(const Board *board, int x, int y) const are not documented:
  parameter 'board'

我在不同的类中有相同的参数const Board * board，生成的文档没有任何问题。我在这里错过了什么吗？

无法记录类方法的参数

0 个答案: