From aef91ce983251fe0384fb58dd87ca1bbc4e0d0d0 Mon Sep 17 00:00:00 2001 From: Elias Steurer Date: Sat, 16 May 2020 14:44:29 +0200 Subject: [PATCH] Add app class documentation --- Docs/ProjectOverview.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/Docs/ProjectOverview.md b/Docs/ProjectOverview.md index cc77f27a..4a76fa01 100644 --- a/Docs/ProjectOverview.md +++ b/Docs/ProjectOverview.md @@ -13,7 +13,11 @@ ScreenPlay consists of 5 projects: ![ProjectOverview.png](ProjectOverview.png) -### ScreenPlay classes +### ScreenPlay App Class +ScreenPlay wrapps all classes into a App.h and App.cpp class. This is easier for unit test integration (not implemented yet!). The main app class is used for owning [all other classes via Q_PROPERTY](https://gitlab.com/kelteseth/ScreenPlay/-/blob/master/ScreenPlay/app.h#L39) to be easily accessible in the GUI/QML. We use the [constructor](https://gitlab.com/kelteseth/ScreenPlay/-/blob/master/ScreenPlay/app.cpp#L44) of the App class to initialize all Qt register types, fonts and to check if another ScreenPlay instance is running. The [init()](https://gitlab.com/kelteseth/ScreenPlay/-/blob/master/ScreenPlay/app.cpp#L103) method is used to initialize all other c++ classes in a certain order! It also sets up some events [signal/slots](https://doc.qt.io/qt-5/signalsandslots.html) like when the user changes the UI language. + +For all other class documentation please visit [ScreenPlayDeveloperDocs](https://kelteseth.gitlab.io/ScreenPlayDeveloperDocs/) + ``` mermaid graph TD