brobeson / Tools

Scripts written to aid software development.
2 stars 1 forks source link

function parameters may not be documented #18

Closed brobeson closed 9 years ago

brobeson commented 9 years ago

Function parameters may not have their names documented. The doxygen generation function, used on this constructor, will produce the Doxygen template shown. Note that the 3rd parameter name is incorrect (it should be direction) and the 4th and 5th parameter names are missing.

/**
 * \brief
 * \details
 * \param[in]  name
 * \param[in]  type
 * \param[in]  IN
 * \param[in]
 * \param[in]
 * \exception  None
 */
parameter(const std::string&   name,
          const std::string&   type,
          const direction_type direction     = direction_type::IN,
          const std::string&   comment       = "",
          const std::string&   default_value = "") noexcept:
    m_name(name),
    m_type(type),
    m_default_parameter(default_parameter),
    m_comment(comment),
    m_direction(direction)
    {}

My current suspicion is that this is due to the default parameters.