summaryrefslogtreecommitdiff
path: root/src/data
diff options
context:
space:
mode:
authorAleks Kissinger <aleks0@gmail.com>2018-01-11 13:39:59 +0100
committerAleks Kissinger <aleks0@gmail.com>2018-01-11 13:39:59 +0100
commit7ba78eb787b925c99bfd5838543bb98e0d4743c8 (patch)
tree9801a5490de3a9c4988affd96f8700fe0e9e0285 /src/data
parentc0bb77059e3c4afa47fe6bfebbf99e230a01992c (diff)
added more source code documentation
Diffstat (limited to 'src/data')
-rw-r--r--src/data/graph.h2
-rw-r--r--src/data/tikzdocument.h2
-rw-r--r--src/data/tikzlexer.l5
-rw-r--r--src/data/tikzparser.y6
4 files changed, 13 insertions, 2 deletions
diff --git a/src/data/graph.h b/src/data/graph.h
index 8856e5c..c25d51b 100644
--- a/src/data/graph.h
+++ b/src/data/graph.h
@@ -1,4 +1,4 @@
-/**
+/*!
* A graph defined by tikz code.
*/
diff --git a/src/data/tikzdocument.h b/src/data/tikzdocument.h
index f574f5c..d3a18b1 100644
--- a/src/data/tikzdocument.h
+++ b/src/data/tikzdocument.h
@@ -1,4 +1,4 @@
-/**
+/*!
* This class contains a tikz Graph, source code, file info, and undo stack. It serves as the model
* in the MVC triple (TikzDocument, TikzView, TikzScene).
*/
diff --git a/src/data/tikzlexer.l b/src/data/tikzlexer.l
index 8dd23c6..800ef8e 100644
--- a/src/data/tikzlexer.l
+++ b/src/data/tikzlexer.l
@@ -1,4 +1,9 @@
%{
+/*!
+ * \file tikzlexer.l
+ *
+ * The lexer for tikz input.
+ */
/*
* Copyright 2010 Chris Heunen
* Copyright 2010-2013 Aleks Kissinger
diff --git a/src/data/tikzparser.y b/src/data/tikzparser.y
index 420b8a0..aa6ac76 100644
--- a/src/data/tikzparser.y
+++ b/src/data/tikzparser.y
@@ -1,4 +1,10 @@
%{
+/*!
+ * \file tikzparser.y
+ *
+ * The parser for tikz input.
+ */
+
/*
* Copyright 2010 Chris Heunen
* Copyright 2010-2013 Aleks Kissinger