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
@@ -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:
@@ -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