Skip to content

Commit

Permalink
Turn on mathjax for some pretty formulae, fixed docstrings.
Browse files Browse the repository at this point in the history
  • Loading branch information
LTLA committed Jul 16, 2024
1 parent d56e796 commit 62918ac
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 3 deletions.
2 changes: 1 addition & 1 deletion docs/Doxyfile
Original file line number Diff line number Diff line change
Expand Up @@ -1694,7 +1694,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
Expand Down
4 changes: 2 additions & 2 deletions include/scran_markers/summarize_effects.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,7 @@ struct SummarizeEffectsOptions {
* The first dimension is the fastest changing, is of length equal to the number of groups, and represents the first group.
* The second dimension is the next fastest changing, is also of length equal to the number of groups, and represents the second group.
* The third dimension is the slowest changing, is of length equal to the number of genes, and represents the gene.
* Thus, an entry \f$(i, j, k)\f$ represents the effect size of gene $k$ for group $i$ against group $j$.
* Thus, an entry \f$(i, j, k)\f$ represents the effect size of gene \f$k\f$ for group \f$i\f$ against group \f$j\f$.
* @param[out] summaries Vector of length equal to the number of groups.
* Each entry corresponds to a group and is used to store the summary statistics for that group.
* Each pointer in any given `SummaryBuffers` should either point to an array of length equal to the number of genes,
Expand All @@ -130,7 +130,7 @@ void summarize_effects(Index_ ngenes, size_t ngroups, const Stat_* effects, cons
* The first dimension is the fastest changing, is of length equal to the number of groups, and represents the first group.
* The second dimension is the next fastest changing, is also of length equal to the number of groups, and represents the second group.
* The third dimension is the slowest changing, is of length equal to the number of genes, and represents the gene.
* Thus, an entry \f$(i, j, k)\f$ represents the effect size of gene $k$ for group $i$ against group $j$.
* Thus, an entry \f$(i, j, k)\f$ represents the effect size of gene \f$k\f$ for group \f$i\f$ against group \f$j\f$.
* @param options Further options.
*
* @return A vector of length equal to the number of groups.
Expand Down

0 comments on commit 62918ac

Please sign in to comment.