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

fixed doc structure

Browse Source
This commit is contained in:
jkriege2 2022-07-23 16:19:34 +02:00
parent c399959774
commit bc7f219aa4
3 changed files with 23 additions and 37 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
doc/dox/jkqtcommon.dox
View File

@ -1,21 +1,12 @@
/*! /*!
\defgroup jkqtptools Support Function libraries (e.g. for JKQTPlotter)
This group contains several tool functions and datatypesthat are neccessary for
JKQTPlotter, JKQTMathtext and the other major classes in this library, but may
also be used separately. The functions and datatypes are sorted into several
functionaly groups.
\defgroup jkqtptools_jkqtcommon JKQTCommon: Diverse Basic Utilities \defgroup jkqtptools_jkqtcommon JKQTCommon: Diverse Basic Utilities
\ingroup jkqtptools
This summarizes all functions from JKQTCommon-library, which provides basic (Qt-bound) tools for all other libs in the package JKQtPlotter (i.e. also JKQtFastPlotter and JKQtMathText). This summarizes all functions from JKQTCommon-library, which provides basic (Qt-bound) tools for all other libs in the package JKQtPlotter (i.e. also JKQtFastPlotter and JKQtMathText).
\defgroup jkqtptools_math_basic Mathematical Functions & Tools \defgroup jkqtptools_math_basic Mathematical Functions & Tools
\ingroup jkqtptools_math \ingroup jkqtptools_jkqtcommon
This group assembles a variety of mathematical tool functions that are used in different places. This group assembles a variety of mathematical tool functions that are used in different places.
@ -23,29 +14,29 @@ This group assembles a variety of mathematical tool functions that are used in d
\defgroup jkqtptools_string String/String-Conversion Tool Functions \defgroup jkqtptools_string String/String-Conversion Tool Functions
\ingroup jkqtptools \ingroup jkqtptools_jkqtcommon
Offers diverse function to convert different datatypes (e.g. double, int, diverse enums) to and from strings and for string manipulation. Offers diverse function to convert different datatypes (e.g. double, int, diverse enums) to and from strings and for string manipulation.
\defgroup jkqtptools_qt Additional Tools for Qt \defgroup jkqtptools_qt Additional Tools for Qt
\ingroup jkqtptools \ingroup jkqtptools_jkqtcommon
\defgroup jkqtptools_qtwidgets Additional Widgets for Qt \defgroup jkqtptools_qtwidgets Additional Widgets for Qt
\ingroup jkqtptools \ingroup jkqtptools_jkqtcommon
\defgroup jkqtptools_drawing Drawing & Graphics Tools \defgroup jkqtptools_drawing Drawing & Graphics Tools
\ingroup jkqtptools \ingroup jkqtptools_jkqtcommon
Specialized drawing functions used by the plotters and LaTeX renderers. Specialized drawing functions used by the plotters and LaTeX renderers.
\defgroup jkqtptools_debugging Debugging Tools \defgroup jkqtptools_debugging Debugging Tools
\ingroup jkqtptools \ingroup jkqtptools_jkqtcommon
Functions that help during debugging (e.g. an assert function/macro). Functions that help during debugging (e.g. an assert function/macro).
\defgroup jkqtptools_codestructuring Code Structuring Tools \defgroup jkqtptools_codestructuring Code Structuring Tools
\ingroup jkqtptools \ingroup jkqtptools_jkqtcommon
Classes and functions that help to structure the code (e.g. RAII constructs) Classes and functions that help to structure the code (e.g. RAII constructs)

17
doc/dox/jkqtcommon_statistics_and_math.dox
View File

@ -2,7 +2,6 @@
\defgroup jkqtcommon_statistics_and_math JKQTCommonStatisticsAndMath: Special Math and Statistics Utilities \defgroup jkqtcommon_statistics_and_math JKQTCommonStatisticsAndMath: Special Math and Statistics Utilities
\ingroup jkqtptools
This summarizes all functions from JKQTCommonStatisticsAndMath-library, which provides special and advanced math and statistics tools, mostly used by JKQtPlotter. This summarizes all functions from JKQTCommonStatisticsAndMath-library, which provides special and advanced math and statistics tools, mostly used by JKQtPlotter.
@ -10,9 +9,23 @@ This summarizes all functions from JKQTCommonStatisticsAndMath-library, which pr
\defgroup jkqtptools_algorithms Diverse Algorithms \defgroup jkqtptools_algorithms Diverse Algorithms
\ingroup jkqtcommon_statistics_and_math \ingroup jkqtcommon_statistics_and_math
\defgroup jkqtptools_math Mathematical Computations & Expression Parsing \defgroup jkqtptools_math_parser Parser/Evaluator for Mathematical Expressions
\ingroup jkqtcommon_statistics_and_math \ingroup jkqtcommon_statistics_and_math
In this group there are classes that form a parser and evluator for mathematical expressions.
In the context of the sequencer program this is a tool class that can be used by the classes
in the project. E.g. used by JKQTPXParsedFunctionLineGraph, JKQTPYParsedFunctionLineGraph
\defgroup jkmpultil JKQTPMathParser: Utilities
\ingroup jkqtptools_math_parser
\defgroup jkmpNodes JKQTPMathParser: Memory Representation of Expressions
\ingroup jkqtptools_math_parser
\defgroup jkmpErrorhandling JKQTPMathParser Error Handling
\ingroup jkqtptools_math_parser
\defgroup jkqtptools_math_array Data Array Tools \defgroup jkqtptools_math_array Data Array Tools
\ingroup jkqtcommon_statistics_and_math \ingroup jkqtcommon_statistics_and_math

20
lib/jkqtcommon_statistics_and_math/jkqtpmathparser.h
View File

@ -18,24 +18,6 @@
*/ */
/*! \defgroup jkmp Parser/Evaluator for Mathematical Expressions
\ingroup jkqtptools_math
In this group there are classes that form a parser and evaluator for mathematical expressions.
In the context of the sequencer program this is a tool class that can be used by the classes
in the project. E.g. used by JKQTPXParsedFunctionLineGraph, JKQTPYParsedFunctionLineGraph
\defgroup jkmpultil JKQTPMathParser: Utilities
\ingroup jkmp
\defgroup jkmpNodes JKQTPMathParser: Memory Representation of Expressions
\ingroup jkmp
\defgroup jkmpErrorhandling JKQTPMathParser Error Handling
\ingroup jkmp
*/
#include <iostream> #include <iostream>
#include <string> #include <string>
#include <cstdio> #include <cstdio>
@ -56,7 +38,7 @@
/*! \brief A simple function parser to parse (build memory tree representation) and /*! \brief A simple function parser to parse (build memory tree representation) and
evaluate simple mathematical expressions evaluate simple mathematical expressions
\ingroup jkmp \ingroup jkqtptools_math_parser
This class implements a simple function parser which can parse This class implements a simple function parser which can parse