documented more classes

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: