我一直在努力让下面的代码摘录文档与doxygen一起正确显示。
我在网上搜索了这个问题;然而，似乎没有显示的文档主要是由于成员函数/变量是私有的。即使我似乎记录了一个非静态的公共成员函数，但我无法使doxygen正常工作。我很感激你的任何帮助。
/**
* @brief Algorithm abstraction.
*
* @tparam float_t `float` or `double`.
* @tparam int_t `int64_t` or similar.
* @tparam StepPolicy Policy for selecting a step-size.
* @tparam OraclePolicy Policy for getting first-order information.
*/
template <class float_t, class int_t, template <class, class> class StepPolicy,
template <class, class> class OraclePolicy>
struct Algorithm : public StepPolicy<float_t, int_t>,
public OraclePolicy<float_t, int_t> {
/**
* @brief Default constructor.
*
*/
Algorithm() = default;
/**
* @brief Constructor with a step-size.
*
* @param[in] step Non-negative step-size value.
*/
Algorithm(float_t step) : StepPolicy<float_t, int_t>{step} {}
/**
* @brief Set the initial step-size of the algorithm.
*
* @param[in] step Non-negative step-size value.
*/
void set_stepsize(float_t step) { StepPolicy<float_t, int_t>::set(step); }
/**
* @brief Get the current step-size of the algorithm.
*
* This does *not* change the state of StepPolicy.
*
* @return float_t Current step-size.
*/
float_t get_stepsize() const { return StepPolicy<float_t, int_t>::get(); }
/**
* @brief Get current step-size based on the algorithm's state.
*
* @param[in] k Current iteration count.
* @param[in] N Dimension of `x` and `dx`.
* @param[in] x Current decision vector.
* @param[in] dx Current first-order information.
* @return float_t Current step-size.
*/
float_t get_stepsize(const int_t k, const int_t N, const float_t *x,
const float_t *dx) {
return StepPolicy<float_t, int_t>::get(k, N, x, dx);
}
private:
int_t k{0};
};
我不确定doxygen是否与有效的代码摘录有关，但上面的代码确实可以编译。它与模板和继承有什么关系吗？我错过了什么吗？我的意思是，对于非继承模板类，doxygen可以完成它的工作。
顺便说一句，我的目录中某处没有任何具体的StepPolicy或OraclePolicy。而且，我可以看到构造函数正确记录。我只是卡住了。
我可以在此处分享我的Doxygen文件，这基本上只是在MathJax相关设置中覆盖的默认值。
提前感谢您的时间。