Added a couple of doxygen comments to gui.h

This commit is contained in:
Rebekah 2022-04-04 14:46:31 -04:00
parent 96557465c2
commit 1cf551d149
Signed by: oneechanhax
GPG Key ID: 183EB7902964DAE5

View File

@ -14,13 +14,19 @@ class IWidget;
#include "canvas.hpp"
#include "input.hpp"
/// Main root object of libpdraw
/**
* The main required global of the library.
* You MUST set g_pGUI to a valid pointer and run Setup() afterwards for anything to function.
*/
class CatGUI {
public:
CatGUI();
~CatGUI();
void Setup();
Canvas* GetRootWindow();
Canvas* GetRootWindow(); /**< Use to get a container you can add widgets to. */
Canvas* m_pRootWindow;
};
/** Must be a valid pointer for library to function. */
extern CatGUI* g_pGUI;