summaryrefslogtreecommitdiff
path: root/src/gui
diff options
context:
space:
mode:
authorAleks Kissinger <aleks0@gmail.com>2019-01-02 17:38:38 +0100
committerAleks Kissinger <aleks0@gmail.com>2019-01-02 17:38:38 +0100
commit904e73cbfa571377ab1860ba7d5a54119ab909e0 (patch)
treeb3619b3066c1600bc117293d6d0d8d9beaeb26be /src/gui
parente090751ebb8e4c7c6a9075587e1017d4ac95cd05 (diff)
added some documentation to the source code
Diffstat (limited to 'src/gui')
-rw-r--r--src/gui/exportdialog.h4
-rw-r--r--src/gui/latexprocess.h5
-rw-r--r--src/gui/previewwindow.h5
-rw-r--r--src/gui/styleeditor.h8
4 files changed, 20 insertions, 2 deletions
diff --git a/src/gui/exportdialog.h b/src/gui/exportdialog.h
index 0f6940b..bcb6879 100644
--- a/src/gui/exportdialog.h
+++ b/src/gui/exportdialog.h
@@ -16,6 +16,10 @@
along with this program. If not, see <https://www.gnu.org/licenses/>.
*/
+/*!
+ * A dialog for exporting a LaTeX-generated preview to PNG, JPG, or PDF.
+ */
+
#ifndef EXPORTDIALOG_H
#define EXPORTDIALOG_H
diff --git a/src/gui/latexprocess.h b/src/gui/latexprocess.h
index 4fe9987..9853883 100644
--- a/src/gui/latexprocess.h
+++ b/src/gui/latexprocess.h
@@ -16,6 +16,11 @@
along with this program. If not, see <https://www.gnu.org/licenses/>.
*/
+/*!
+ * Run pdflatex and dump its output to the appropriate tab of
+ * the PreviewWindow.
+ */
+
#ifndef LATEXPROCESS_H
#define LATEXPROCESS_H
diff --git a/src/gui/previewwindow.h b/src/gui/previewwindow.h
index cf2ffd8..a14303b 100644
--- a/src/gui/previewwindow.h
+++ b/src/gui/previewwindow.h
@@ -16,6 +16,11 @@
along with this program. If not, see <https://www.gnu.org/licenses/>.
*/
+/*!
+ * Displays a LaTeX-generated PDF preview using Poppler. The right-click
+ * menu has options for exporting to file or clipboard.
+ */
+
#ifndef PREVIEWWINDOW_H
#define PREVIEWWINDOW_H
diff --git a/src/gui/styleeditor.h b/src/gui/styleeditor.h
index e9a8a89..2c35d56 100644
--- a/src/gui/styleeditor.h
+++ b/src/gui/styleeditor.h
@@ -16,6 +16,10 @@
along with this program. If not, see <https://www.gnu.org/licenses/>.
*/
+/*!
+ * A GUI editor for .tikzstyles files.
+ */
+
#ifndef STYLEEDITOR_H
#define STYLEEDITOR_H
@@ -35,8 +39,8 @@ class StyleEditor : public QMainWindow
Q_OBJECT
public:
- explicit StyleEditor(QWidget *parent = 0);
- ~StyleEditor();
+ explicit StyleEditor(QWidget *parent = nullptr);
+ ~StyleEditor() override;
void open();
void save();