mirrors/JKQtPlotter
1
0
Fork 0
mirror of https://github.com/jkriege2/JKQtPlotter.git synced 2024-12-25 01:51:49 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

rename, doc update

Browse Source
This commit is contained in:
jkriege2 2024-01-21 21:59:51 +01:00
parent 31759543da
commit d0a00a8c4c
6 changed files with 15 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
doc/dox/jkqtfastplotter.dox
View File

@ -14,12 +14,12 @@
\defgroup jkqtfastplotter_PlotItems Plot Elements available in JKQTFastPlotter
\defgroup jkqtfastplotter_PlotItems DEPRECATED: Plot Elements available in JKQTFastPlotter
\ingroup jkqtfastplotter
\deprecated The class JKQTFastPlotter and all its support classes are deprecated and will be removed in future versions.
\defgroup jkqtfastplotter_tools Tool Functions, Enums, Classes for JKQTFastPlotter
\defgroup jkqtfastplotter_tools Tool DEPRECATED: Functions, Enums, Classes for JKQTFastPlotter
\ingroup jkqtfastplotter
\deprecated The class JKQTFastPlotter and all its support classes are deprecated and will be removed in future versions.

0
doc/dox/jkqtcommon_statistics_and_math.dox → doc/dox/jkqtmath.dox
View File

5
doc/dox/jkqtmathtext.dox
View File

@ -27,6 +27,8 @@
\defgroup jkqtmathtext_general_languages Supported Markup Languages
\ingroup jkqtmathtext_general
JKQTMathText was designed to support different math markup parsers. By default only a \ref jkqtmathtext_general_latex parser is available, but it would be possible to e.g. add support for MathML or other markup languages. You simply have to implement a new JKQTMathTextParser.
\defgroup jkqtmathtext_general_latex LaTeX Markup
\ingroup jkqtmathtext_general_languages
@ -61,6 +63,9 @@
\defgroup jkqtmathtext_parser Math Markup Parser Classes
\ingroup jkqtmathtext_interaltools
JKQTMathText was designed to support different math markup parsers. By default only a \ref jkqtmathtext_general_latex JKQTMathTextLatexParser parser is available, but it would be possible to e.g. add support for MathML or other markup languages. You simply have to implement a new JKQTMathTextParser.
\defgroup jkqtmathtext_tools Tool Functions and Types for JKQTMathText
\ingroup jkqtmathtext_interaltools

2
doc/dox/jkqtplotter_usage.dox
View File

@ -3,6 +3,8 @@
\defgroup jkqtplotter_general_usage Usage of JKQTPlotter
\ingroup jkqtplotter_general
\see See \ref page_buildinstructions for detailed build-instructions and on how to link against JKQTPlotter!
\defgroup jkqtplotter_general_usage_jkqtbaseplotter Usage of JKQTBasePlotter Non-Visible Class
\ingroup jkqtplotter_general_usage

3
lib/jkqtmathtext/jkqtmathtext.h
View File

@ -82,6 +82,9 @@ class JKQTMathTextVerticalListNode; // forward
\section JKQTMathTextUsage Usage
\see See \ref page_buildinstructions for detailed build-instructions and on how to link against JKQTMathText!
\subsection JKQTMathTextUsageParsing Parsing Functions
The class provieds two flavours of a parsing function:
- There is a function \c parse(markup, markupType) that accepts the markup, the type of markup (as enum DefaultParserTypes) and parser options.

4
lib/jkqtmathtext/parsers/jkqtmathtextparser.h
View File

@ -34,9 +34,11 @@
class JKQTMathTextNode; // forward
/*! \brief base class for all parsers used by JKQTMathText
/*! \brief base class for all math markup parsers used by JKQTMathText
\ingroup jkqtmathtext_parser
\see JKQTMathTextLatexParser for an implementation of a JKQTMathTextParser that parses LaTeX markup.
*/
class JKQTMATHTEXT_LIB_EXPORT JKQTMathTextParser : public QObject {
Q_OBJECT