From 146772b118fd6f67afe12b4e56e69feff2540806 Mon Sep 17 00:00:00 2001 From: LTLA Date: Thu, 5 Sep 2024 08:51:35 -0700 Subject: [PATCH] Turn on Mathjax and minor docstring fixes. --- docs/Doxyfile | 4 ++-- include/tatami_stats/medians.hpp | 8 ++++---- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/Doxyfile b/docs/Doxyfile index 276f9b3..8a93450 100644 --- a/docs/Doxyfile +++ b/docs/Doxyfile @@ -1688,7 +1688,7 @@ FORMULA_MACROFILE = # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. -USE_MATHJAX = NO +USE_MATHJAX = YES # With MATHJAX_VERSION it is possible to specify the MathJax version to be used. # Note that the different versions of MathJax have different requirements with @@ -1730,7 +1730,7 @@ MATHJAX_FORMAT = HTML-CSS # - in case of MathJax version 3: https://cdn.jsdelivr.net/npm/mathjax@3 # This tag requires that the tag USE_MATHJAX is set to YES. -MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest +MATHJAX_RELPATH = # The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax # extension names that should be enabled during MathJax rendering. For example diff --git a/include/tatami_stats/medians.hpp b/include/tatami_stats/medians.hpp index 3ef36e8..3140d86 100644 --- a/include/tatami_stats/medians.hpp +++ b/include/tatami_stats/medians.hpp @@ -264,7 +264,7 @@ void apply(bool row, const tatami::Matrix* p, Output_* output, c * @tparam Value_ Type of the matrix value. * @tparam Index_ Type of the row/column indices. * - * @param p Shared pointer to a `tatami::Matrix`. + * @param p Pointer to a `tatami::Matrix`. * @param mopt Median calculation options. * * @return A vector of length equal to the number of columns, containing the column medians. @@ -284,7 +284,7 @@ std::vector by_column(const tatami::Matrix* p, const Op * @tparam Value_ Type of the matrix value. * @tparam Index_ Type of the row/column indices. * - * @param p Shared pointer to a `tatami::Matrix`. + * @param p Pointer to a `tatami::Matrix`. * * @return A vector of length equal to the number of columns, containing the column medians. */ @@ -301,7 +301,7 @@ std::vector by_column(const tatami::Matrix* p) { * @tparam Value_ Type of the matrix value. * @tparam Index_ Type of the row/column indices. * - * @param p Shared pointer to a `tatami::Matrix`. + * @param p Pointer to a `tatami::Matrix`. * @param mopt Median calculation options. * * @return A vector of length equal to the number of rows, containing the row medians. @@ -321,7 +321,7 @@ std::vector by_row(const tatami::Matrix* p, const Optio * @tparam Value_ Type of the matrix value. * @tparam Index_ Type of the row/column indices. * - * @param p Shared pointer to a `tatami::Matrix`. + * @param p Pointer to a `tatami::Matrix`. * * @return A vector of length equal to the number of rows, containing the row medians. */