diff options
author | Aleks Kissinger <aleks0@gmail.com> | 2018-01-11 13:39:59 +0100 |
---|---|---|
committer | Aleks Kissinger <aleks0@gmail.com> | 2018-01-11 13:39:59 +0100 |
commit | 7ba78eb787b925c99bfd5838543bb98e0d4743c8 (patch) | |
tree | 9801a5490de3a9c4988affd96f8700fe0e9e0285 /src/gui | |
parent | c0bb77059e3c4afa47fe6bfebbf99e230a01992c (diff) |
added more source code documentation
Diffstat (limited to 'src/gui')
-rw-r--r-- | src/gui/mainwindow.h | 2 | ||||
-rw-r--r-- | src/gui/nodeitem.h | 2 | ||||
-rw-r--r-- | src/gui/propertypalette.h | 2 | ||||
-rw-r--r-- | src/gui/tikzscene.h | 2 | ||||
-rw-r--r-- | src/gui/tikzview.h | 2 | ||||
-rw-r--r-- | src/gui/toolpalette.h | 2 | ||||
-rw-r--r-- | src/gui/undocommands.h | 4 |
7 files changed, 9 insertions, 7 deletions
diff --git a/src/gui/mainwindow.h b/src/gui/mainwindow.h index f27677a..8adf1bc 100644 --- a/src/gui/mainwindow.h +++ b/src/gui/mainwindow.h @@ -1,4 +1,4 @@ -/** +/*! * A top-level window, which contains a single TikzDocument. */ diff --git a/src/gui/nodeitem.h b/src/gui/nodeitem.h index 9a3edb0..eb3fbb3 100644 --- a/src/gui/nodeitem.h +++ b/src/gui/nodeitem.h @@ -1,4 +1,4 @@ -/** +/*! * A QGraphicsItem that handles drawing a single node. */ diff --git a/src/gui/propertypalette.h b/src/gui/propertypalette.h index 7910d70..80f2d88 100644 --- a/src/gui/propertypalette.h +++ b/src/gui/propertypalette.h @@ -1,4 +1,4 @@ -/** +/*! * Enables the user to edit properties of the graph, as well as the selected node/edge. */ diff --git a/src/gui/tikzscene.h b/src/gui/tikzscene.h index 6817792..936d42e 100644 --- a/src/gui/tikzscene.h +++ b/src/gui/tikzscene.h @@ -1,4 +1,4 @@ -/** +/*! * Manage the scene, which contains a single Graph, and respond to user input. This serves as * the controller for the MVC (TikzDocument, TikzView, TikzScene). */ diff --git a/src/gui/tikzview.h b/src/gui/tikzview.h index fc3cba4..f89729b 100644 --- a/src/gui/tikzview.h +++ b/src/gui/tikzview.h @@ -1,4 +1,4 @@ -/** +/*! * Display a Graph, and manage any user input that purely changes the view (e.g. Zoom). This * serves as the view in the MVC (TikzDocument, TikzView, TikzScene). */ diff --git a/src/gui/toolpalette.h b/src/gui/toolpalette.h index ba6aed5..c28b5a1 100644 --- a/src/gui/toolpalette.h +++ b/src/gui/toolpalette.h @@ -1,4 +1,4 @@ -/** +/*! * A small window that lets the user select the current editing tool. */ diff --git a/src/gui/undocommands.h b/src/gui/undocommands.h index ffff876..0a7dece 100644 --- a/src/gui/undocommands.h +++ b/src/gui/undocommands.h @@ -1,4 +1,6 @@ -/** +/*! + * \file undocommands.h + * * All changes to a TikzDocument are done via subclasses of QUndoCommand. When a controller * (e.g. TikzScene) gets input from the user to change the document, it will push one of * these commands onto the TikzDocument's undo stack, which automatically calls the redo() |