summaryrefslogtreecommitdiffstats
path: root/src/htmlgen.cpp
diff options
context:
space:
mode:
authoralbert-github <albert.tests@gmail.com>2020-02-25 12:02:00 (GMT)
committeralbert-github <albert.tests@gmail.com>2020-02-25 12:02:00 (GMT)
commitf15360bf1445b5edfdc82fd027fdab0f29e1d8e5 (patch)
treebfda40d8d39a96e5c1ded8fb90ab4d409337e5a9 /src/htmlgen.cpp
parent3b392af822d81ae51919feb2c2fc4c539238bb3b (diff)
downloadDoxygen-f15360bf1445b5edfdc82fd027fdab0f29e1d8e5.zip
Doxygen-f15360bf1445b5edfdc82fd027fdab0f29e1d8e5.tar.gz
Doxygen-f15360bf1445b5edfdc82fd027fdab0f29e1d8e5.tar.bz2
Removing warnings from doxygen internal documentation
Although there is not a lot of doxygen internal documentation, it still should not produce warnings.
Diffstat (limited to 'src/htmlgen.cpp')
-rw-r--r--src/htmlgen.cpp10
1 files changed, 9 insertions, 1 deletions
diff --git a/src/htmlgen.cpp b/src/htmlgen.cpp
index f9775fd..2dc62fa 100644
--- a/src/htmlgen.cpp
+++ b/src/htmlgen.cpp
@@ -114,20 +114,28 @@ static void writeServerSearchBox(FTextStream &t,const char *relPath,bool highlig
}
//------------------------------------------------------------------------
-/// Convert a set of LaTeX `\(re)newcommand` to a form readable by MathJax
+/// Convert a set of LaTeX commands `\(re)newcommand` to a form readable by MathJax
/// LaTeX syntax:
+/// ```
/// \newcommand{\cmd}{replacement}
/// or
/// \renewcommand{\cmd}{replacement}
+/// ```
/// MathJax syntax:
+/// ```
/// cmd: "{replacement}"
+/// ```
///
/// LaTeX syntax:
+/// ```
/// \newcommand{\cmd}[nr]{replacement}
/// or
/// \renewcommand{\cmd}[nr]{replacement}
+/// ```
/// MathJax syntax:
+/// ```
/// cmd: ["{replacement}",nr]
+/// ```
static QCString getConvertLatexMacro()
{
QCString macrofile = Config_getString(FORMULA_MACROFILE);