Is there standard way to include a references section for a doxygen docstring in C++? For example, for documenting references that influenced the implementation, the python library statsmodels sometimes includes a References section in the docstring (see multivariate PCA).
To illustrate what I currently have, the below code
/** * @brief Return laplacian as linear operator on u(x,y) assuming homogenous dirichlet BCs. * * From [MIT Intro Linear PDEs](https://github.com/mitmath/18303/blob/m ... onFD.ipynb) * * @param n Number of grid points in the x or y direction. * @return Eigen::SparseMatrix */ Eigen::SparseMatrix laplacian(size_t n); generates the below in doxygen after calling cmake --build build --targets docs where docs/ contains the corresponding CMakeLists.txt specifying which directory to get files to be documented,

but what I want is to move "From MIT Intro Linear PDEs" to something like
/** * @brief Return laplacian as linear operator on u(x,y) assuming homogenous dirichlet BCs. * * @param n Number of grid points in the x or y direction. * @return Eigen::SparseMatrix * @references * [1] : [MIT Intro Linear PDEs](https://github.com/mitmath/18303/blob/m ... onFD.ipynb) * [2] : some other reference here */ Eigen::SparseMatrix laplacian(size_t n); in order to clearly delineate a references section like below,

Источник: https://stackoverflow.com/questions/781 ... or-doxygen
Мобильная версия