From deaa0aa8407310a869e96eccb4380fc128abc443 Mon Sep 17 00:00:00 2001
From: itsmattkc <itsmattkc@gmail.com>
Date: Sun, 23 Jun 2019 01:19:40 -0700
Subject: [PATCH] documented more classes

---
 app/render/gl/shaderptr.h                    |  3 ++
 app/tool/tool.h                              | 29 ++++++++++++++++++++
 app/widget/projectexplorer/projectexplorer.h | 10 +++++++
 app/widget/projecttoolbar/projecttoolbar.h   |  8 ++++++
 4 files changed, 50 insertions(+)

diff --git a/app/render/gl/shaderptr.h b/app/render/gl/shaderptr.h
index ba091d573..7d2601721 100644
--- a/app/render/gl/shaderptr.h
+++ b/app/render/gl/shaderptr.h
@@ -24,6 +24,9 @@
 #include <QOpenGLShaderProgram>
 #include <memory>
 
+/**
+ * @brief A simple shared_ptr around QOpenGLShaderProgram to simplify shader creation/destruction
+ */
 using ShaderPtr = std::shared_ptr<QOpenGLShaderProgram>;
 
 #endif // QOPENGLSHADERPROGRAMPTR_H
diff --git a/app/tool/tool.h b/app/tool/tool.h
index e840f8fcd..2d4ca2407 100644
--- a/app/tool/tool.h
+++ b/app/tool/tool.h
@@ -24,18 +24,47 @@
 namespace olive {
 namespace tool {
 
+/**
+ * @brief The Tool enum
+ *
+ * A list of tools that can be used throughout the application
+ */
 enum Tool {
+  /// No tool. This should never be set as the application tool, its only real purpose is to indicate the lack of
+  /// a tool somewhere.
   kNone,
+
+  /// Pointer tool
   kPointer,
+
+  /// Edit tool
   kEdit,
+
+  /// Ripple tool
   kRipple,
+
+  /// Razor tool
   kRazor,
+
+  /// Slip tool
   kSlip,
+
+  /// Slide tool
   kSlide,
+
+  /// Hand tool
   kHand,
+
+  /// Zoom tool
   kZoom,
+
+  /// Transition tool
   kTransition,
+
+  /// Record tool
   kRecord,
+
+  /// Add tool
   kAdd
 };
 
diff --git a/app/widget/projectexplorer/projectexplorer.h b/app/widget/projectexplorer/projectexplorer.h
index 5390a0a8f..4850bf432 100644
--- a/app/widget/projectexplorer/projectexplorer.h
+++ b/app/widget/projectexplorer/projectexplorer.h
@@ -27,6 +27,16 @@
 #include "project/project.h"
 #include "project/projectviewmodel.h"
 
+/**
+ * @brief The ProjectExplorer class
+ *
+ * A widget for browsing through a Project structure.
+ *
+ * ProjectExplorer automatically handles the view<->model system using a ProjectViewModel. Therefore, all that needs to
+ * be provided is the Project structure itself.
+ *
+ * This widget contains three views, tree view, list view, and icon view. These can be switched at any time.
+ */
 class ProjectExplorer : public QStackedWidget
 {
 public:
diff --git a/app/widget/projecttoolbar/projecttoolbar.h b/app/widget/projecttoolbar/projecttoolbar.h
index 9389ab0d3..f82b72c5a 100644
--- a/app/widget/projecttoolbar/projecttoolbar.h
+++ b/app/widget/projecttoolbar/projecttoolbar.h
@@ -25,6 +25,14 @@
 #include <QLineEdit>
 #include <QPushButton>
 
+/**
+ * @brief The ProjectToolbar class
+ *
+ * A toolbar consisting of project functions (new/open/save), edit functions (undo/redo), a search field, and a
+ * project view selector (tree/icon/list).
+ *
+ * This object's signals can be connected to various functions in the application for better user experience.
+ */
 class ProjectToolbar : public QWidget
 {
   Q_OBJECT