summaryrefslogtreecommitdiff
path: root/starmath/inc/visitors.hxx
diff options
context:
space:
mode:
authordante <dante19031999@gmail.com>2020-11-04 13:49:06 +0100
committerNoel Grandin <noel.grandin@collabora.co.uk>2020-11-07 21:30:22 +0100
commit7acf5fe037e50557c6ddbc8d9a797dc727ce4001 (patch)
tree261058c56f44731b30b988f9aec85204a63be38a /starmath/inc/visitors.hxx
parent03a9a80125cf887d26348486b71d78d80c99344d (diff)
Added documentation on starmath.
Gives basic description about file content and functionallity. Will allow new programmers to follow the code better. Change-Id: I76a9d61781332e3341130276c1c78ecf82e799a0 Reviewed-on: https://gerrit.libreoffice.org/c/core/+/105290 Tested-by: Jenkins Reviewed-by: Noel Grandin <noel.grandin@collabora.co.uk>
Diffstat (limited to 'starmath/inc/visitors.hxx')
-rw-r--r--starmath/inc/visitors.hxx13
1 files changed, 13 insertions, 0 deletions
diff --git a/starmath/inc/visitors.hxx b/starmath/inc/visitors.hxx
index 1591d3757860..4d3c4decae23 100644
--- a/starmath/inc/visitors.hxx
+++ b/starmath/inc/visitors.hxx
@@ -6,6 +6,19 @@
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*/
+
+/** Visitors are an easy way to automating operations with nodes.
+ *
+ * The available visitors are:
+ * SmVisitor base class
+ * SmDefaultingVisitor default visitor
+ * SmDrawingVisitor draws formula
+ * SmCaretPosGraphBuildingVisitor position of the node inside starmath code
+ * SmCloningVisitor duplicate nodes
+ * SmNodeToTextVisitor create code from nodes
+ *
+ */
+
#ifndef INCLUDED_STARMATH_INC_VISITORS_HXX
#define INCLUDED_STARMATH_INC_VISITORS_HXX