From 732c37a194a97dbba35a60ac4793c3f266d9f65d Mon Sep 17 00:00:00 2001
From: Lynix <lynix680@gmail.com>
Date: Sat, 5 Aug 2017 20:51:48 +0200
Subject: [PATCH] Sdk/BaseWidget: Begin doc

---
 SDK/src/NDK/BaseWidget.cpp | 25 +++++++++++++++++++++++++
 1 file changed, 25 insertions(+)

diff --git a/SDK/src/NDK/BaseWidget.cpp b/SDK/src/NDK/BaseWidget.cpp
index c4ef2d1f8..baff9f2d7 100644
--- a/SDK/src/NDK/BaseWidget.cpp
+++ b/SDK/src/NDK/BaseWidget.cpp
@@ -11,6 +11,20 @@
 
 namespace Ndk
 {
+	/*!
+	* \ingroup NDK
+	* \class Ndk::BaseWidget
+	* \brief Abstract class serving as a base class for all widgets
+	*/
+
+	/*!
+	* \brief Constructs a BaseWidget object using another widget as its parent
+	*
+	* \param parent Parent widget, must be valid and attached to a canvas
+	*
+	* Constructs a BaseWidget object using another widget as a base.
+	* This will also register the widget to the canvas owning the top-most widget.
+	*/
 	BaseWidget::BaseWidget(BaseWidget* parent) :
 	BaseWidget()
 	{
@@ -24,11 +38,19 @@ namespace Ndk
 		RegisterToCanvas();
 	}
 
+	/*!
+	* \brief Frees the widget, unregistering it from its canvas
+	*/
 	BaseWidget::~BaseWidget()
 	{
 		UnregisterFromCanvas();
 	}
 
+	/*!
+	* \brief Destroy the widget, deleting it in the process.
+	*
+	* Calling this function immediately destroys the widget, freeing its memory.
+	*/
 	void BaseWidget::Destroy()
 	{
 		NazaraAssert(this != m_canvas, "Canvas cannot be destroyed by calling Destroy()");
@@ -36,6 +58,9 @@ namespace Ndk
 		m_widgetParent->DestroyChild(this); //< This does delete us
 	}
 
+	/*!
+	* \brief Enable or disables the widget background.
+	*/
 	void BaseWidget::EnableBackground(bool enable)
 	{
 		if (m_backgroundEntity.IsValid() == enable)