documented more classes

This commit is contained in:
itsmattkc
2019-06-23 01:19:40 -07:00
parent 77da785416
commit deaa0aa840
4 changed files with 50 additions and 0 deletions
+3
View File
@@ -24,6 +24,9 @@
#include <QOpenGLShaderProgram> #include <QOpenGLShaderProgram>
#include <memory> #include <memory>
/**
* @brief A simple shared_ptr around QOpenGLShaderProgram to simplify shader creation/destruction
*/
using ShaderPtr = std::shared_ptr<QOpenGLShaderProgram>; using ShaderPtr = std::shared_ptr<QOpenGLShaderProgram>;
#endif // QOPENGLSHADERPROGRAMPTR_H #endif // QOPENGLSHADERPROGRAMPTR_H
+29
View File
@@ -24,18 +24,47 @@
namespace olive { namespace olive {
namespace tool { namespace tool {
/**
* @brief The Tool enum
*
* A list of tools that can be used throughout the application
*/
enum Tool { 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, kNone,
/// Pointer tool
kPointer, kPointer,
/// Edit tool
kEdit, kEdit,
/// Ripple tool
kRipple, kRipple,
/// Razor tool
kRazor, kRazor,
/// Slip tool
kSlip, kSlip,
/// Slide tool
kSlide, kSlide,
/// Hand tool
kHand, kHand,
/// Zoom tool
kZoom, kZoom,
/// Transition tool
kTransition, kTransition,
/// Record tool
kRecord, kRecord,
/// Add tool
kAdd kAdd
}; };
@@ -27,6 +27,16 @@
#include "project/project.h" #include "project/project.h"
#include "project/projectviewmodel.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 class ProjectExplorer : public QStackedWidget
{ {
public: public:
@@ -25,6 +25,14 @@
#include <QLineEdit> #include <QLineEdit>
#include <QPushButton> #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 class ProjectToolbar : public QWidget
{ {
Q_OBJECT Q_OBJECT