Documentation

BansheeEditor/Include/BsGUIColor.h

@@ -8,7 +8,7 @@
 namespace BansheeEngine
 {
 	/**
-	 * @brief	GUI elements that displays the set color. RGB and alpha
+	 * @brief	GUI element that displays the set color. RGB and alpha
 	 *			values are displayed separately.
 	 */
 	class GUIColor : public GUIElement

BansheeEditor/Include/BsGUIFloatField.h

@@ -5,18 +5,40 @@
 
 namespace BansheeEngine
 {
+	/**
+	 * @brief	A composite GUI object representing an editor field. Editor fields are a combination
+	 *			of a label and an input field. Label is optional. This specific implementation
+	 *			displays a floating point input field.
+	 */
 	class BS_ED_EXPORT GUIFloatField : public TGUIField<GUIFloatField>
 	{
 	public:
+		/**
+		 * Returns type name of the GUI element used for finding GUI element styles. 
+		 */
 		static const String& getGUITypeName();
+
+		/**
+		 * Style type name for the internal input box.
+		 */
 		static const String& getInputStyleType();
 
 		GUIFloatField(const PrivatelyConstruct& dummy, const GUIContent& labelContent, UINT32 labelWidth,
 			const String& style, const GUIDimensions& dimensions, bool withLabel);
 
+		/**
+		 * @brief	Returns the value of the input field.
+		 */
 		float getValue() const { return mValue; }
+
+		/**
+		 * @brief	Sets a new value in the input field.
+		 */
 		void setValue(float value);
 
+		/**
+		 * @brief	Checks is the input field currently active.
+		 */
 		bool hasInputFocus() const { return mHasInputFocus; }
 
 		/**
@@ -24,21 +46,55 @@ namespace BansheeEngine
 		 */
 		virtual void setTint(const Color& color) override;
 
-		Event<void(float)> onValueChanged;
+		Event<void(float)> onValueChanged; /**< Triggers when the internal value changes. */
 	protected:
 		virtual ~GUIFloatField();
 
+		/**
+		 * @copydoc	GUIElementContainer::updateClippedBounds
+		 */
 		void updateClippedBounds() override;
 
+		/**
+		 * @copydoc	GUIElementContainer::_hasCustomCursor
+		 */
 		bool _hasCustomCursor(const Vector2I position, CursorType& type) const override;
+
+		/**
+		 * @copydoc	GUIElementContainer::_mouseEvent
+		 */
 		virtual bool _mouseEvent(const GUIMouseEvent& ev) override;
+
+		/**
+		 * @copydoc	GUIElementContainer::styleUpdated
+		 */
 		void styleUpdated() override;
 
+		/**
+		 * @brief	Triggered when the input box value changes.
+		 */
 		void valueChanged(const WString& newValue);
+
+		/**
+		 * @brief	Triggered when the input box value changes, but unlike the previous
+		 *			overload the value is parsed into a floating point value.
+		 */
 		void valueChanged(float newValue);
+
+		/**
+		 * @brief	Triggers when the input box receives keyboard focus.
+		 */
 		void focusGained();
+
+		/**
+		 * @brief	Triggers when the input box loses keyboard focus.
+		 */
 		void focusLost();
 
+		/**
+		 * @brief	Callback that checks can the provided string be
+		 *			converted to a floating point value.
+		 */
 		static bool floatFilter(const WString& str);
 
 		static const float DRAG_SPEED;

BansheeEditor/Include/BsGUIFoldout.h

@@ -5,21 +5,63 @@
 
 namespace BansheeEngine
 {
+	/**
+	 * @brief	Composite GUI element that contains a toggle button and a label.
+	 *			Used for handling expand/collapse operations, although it's up to
+	 *			the caller to actually handle the #onStateChanged event.
+	 */
 	class BS_ED_EXPORT GUIFoldout : public GUIElementContainer
 	{
 		struct PrivatelyConstruct {};
 
 	public:
+		/**
+		 * Returns type name of the GUI element used for finding GUI element styles. 
+		 */
 		static const String& getGUITypeName();
+
+		/**
+		 * Returns GUI style type name for the internal toggle button.
+		 */
 		static const String& getFoldoutButtonStyleType();
+
+		/**
+		 * Returns GUI style type name for the internal label.
+		 */
 		static const String& getLabelStyleType();
 
+		/**
+		 * @brief	Creates a new GUI foldout element.
+		 *
+		 * @param	label			Label to display in the foldout title.
+		 * @param	options			Options that allow you to control how is the element positioned and sized.
+		 *							This will override any similar options set by style.
+		 * @param	styleName		Optional style to use for the element. Style will be retrieved
+		 *							from GUISkin of the GUIWidget the element is used on. If not specified
+		 *							default style is used.
+		 */
 		static GUIFoldout* create(const HString& label, const GUIOptions& options, const String& style = StringUtil::BLANK);
+
+		/**
+		 * @brief	Creates a new GUI foldout element.
+		 *
+		 * @param	label			Label to display in the foldout title.
+		 * @param	styleName		Optional style to use for the element. Style will be retrieved
+		 *							from GUISkin of the GUIWidget the element is used on. If not specified
+		 *							default style is used.
+		 */
 		static GUIFoldout* create(const HString& label, const String& style = StringUtil::BLANK);
 
 		GUIFoldout(const PrivatelyConstruct& dummy, const HString& label, const String& style, const GUIDimensions& dimensions);
 
+		/**
+		 * @brief	Checks is the foldout expanded (i.e. the toggle button is active)
+		 */
 		bool isExpanded() const { return mIsExpanded; }
+
+		/**
+		 * @brief	Expands or collapses the foldout (i.e. changes the toggle button state)
+		 */
 		void setExpanded(bool expanded);
 
 		/**
@@ -30,18 +72,31 @@ namespace BansheeEngine
 		/**
 		 * @copydoc	GUIElement::setTint
 		 */
-		virtual void setTint(const Color& color);
+		virtual void setTint(const Color& color) override;
 
-		void _updateLayoutInternal(const GUILayoutData& data);
+		/**
+		 * @copydoc	GUIElement::_updateLayoutInternal
+		 */
+		void _updateLayoutInternal(const GUILayoutData& data) override;
 
-		Vector2I _getOptimalSize() const;
+		/**
+		 * @copydoc	GUIElement::_getOptimalSize
+		 */
+		Vector2I _getOptimalSize() const override;
 
-		Event<void(bool)> onStateChanged;
+		Event<void(bool)> onStateChanged; /**< Triggered when the foldout is expanded or collapsed. True means expanded, false otherwise. */
 	protected:
 		virtual ~GUIFoldout();
 
+		/**
+		 * @brief	Callback triggered when the internal toggle button is toggled.
+		 */
 		void toggleTriggered(bool value);
-		void styleUpdated();
+
+		/**
+		 * @copydoc	GUIElement::_getOptimalSize
+		 */
+		void styleUpdated() override;
 
 		GUILabel* mLabel;
 		GUIToggle* mToggle;

BansheeEditor/Include/BsGUIIntField.h

@@ -5,19 +5,46 @@
 
 namespace BansheeEngine
 {
+	/**
+	 * @brief	A composite GUI object representing an editor field. Editor fields are a combination
+	 *			of a label and an input field. Label is optional. This specific implementation
+	 *			displays a integer input field.
+	 */
 	class BS_ED_EXPORT GUIIntField : public TGUIField<GUIIntField>
 	{
 	public:
+		/**
+		 * Returns type name of the GUI element used for finding GUI element styles. 
+		 */
 		static const String& getGUITypeName();
+
+		/**
+		 * Style type name for the internal input box.
+		 */
 		static const String& getInputStyleType();
 
 		GUIIntField(const PrivatelyConstruct& dummy, const GUIContent& labelContent, UINT32 labelWidth,
 			const String& style, const GUIDimensions& dimensions, bool withLabel);
 
+		/**
+		 * @brief	Returns the value of the input field.
+		 */
 		INT32 getValue() const { return mValue; }
+
+		/**
+		 * @brief	Sets a new value in the input field.
+		 */
 		void setValue(INT32 value);
+
+		/**
+		 * @brief	Sets a minimum and maximum allow values in the input field.
+		 *			Set to large negative/positive values if you don't require clamping.
+		 */
 		void setRange(INT32 min, INT32 max);
 
+		/**
+		 * @brief	Checks is the input field currently active.
+		 */
 		bool hasInputFocus() const { return mHasInputFocus; }
 
 		/**
@@ -25,21 +52,55 @@ namespace BansheeEngine
 		 */
 		virtual void setTint(const Color& color) override;
 
-		Event<void(INT32)> onValueChanged;
+		Event<void(INT32)> onValueChanged; /**< Triggers when the internal value changes. */
 	protected:
 		virtual ~GUIIntField();
 
+		/**
+		 * @copydoc	GUIElement::updateClippedBounds
+		 */
 		void updateClippedBounds() override;
 
+		/**
+		 * @copydoc	GUIElement::_hasCustomCursor
+		 */
 		bool _hasCustomCursor(const Vector2I position, CursorType& type) const override;
+
+		/**
+		 * @copydoc	GUIElement::_mouseEvent
+		 */
 		bool _mouseEvent(const GUIMouseEvent& ev)  override;
+
+		/**
+		 * @copydoc	GUIElement::styleUpdated
+		 */
 		void styleUpdated() override;
 
+		/**
+		 * @brief	Triggered when the input box value changes.
+		 */
 		void valueChanged(const WString& newValue);
+
+		/**
+		 * @brief	Triggered when the input box value changes, but unlike the previous
+		 *			overload the value is parsed into an integer value.
+		 */
 		void valueChanged(INT32 newValue);
+
+		/**
+		 * @brief	Triggers when the input box receives keyboard focus.
+		 */
 		void focusGained();
+
+		/**
+		 * @brief	Triggers when the input box loses keyboard focus.
+		 */
 		void focusLost();
 
+		/**
+		 * @brief	Callback that checks can the provided string be
+		 *			converted to an integer value.
+		 */
 		static bool intFilter(const WString& str);
 
 		static const INT32 DRAG_SPEED;

BansheeEditor/Include/BsGUIMenuBar.h

@@ -5,8 +5,18 @@
 
 namespace BansheeEngine
 {
+	/**
+	 * @brief	A menu bar GUI element that contains a horizontal list of elements
+	 *			that can each be expanded into a hierarchical sub-menus. Contents
+	 *			of the menu bar are customizable once created.
+	 *
+	 *			The menu bar also displays the minimize, maximize and close buttons for the window.
+	 */
 	class BS_ED_EXPORT GUIMenuBar
 	{
+		/**
+		 * @brief	Contains data about the top level menu elements.
+		 */
 		struct GUIMenuBarData
 		{
 			WString name;
@@ -15,14 +25,55 @@ namespace BansheeEngine
 		};
 
 	public:
+		/**
+		 * @brief	Constructs a new menu bar.
+		 *
+		 * @param	parent			Parent GUI widget the menu bar will be docked in.
+		 * @param	parentWindow	Window to trigger the min/max/close events on.
+		 */
 		GUIMenuBar(GUIWidget* parent, RenderWindow* parentWindow);
 		virtual ~GUIMenuBar();
 
+		/**
+		 * @brief	Sets the area of the menu bar, in pixels relative
+		 *			to the parent GUI widget.
+		 */
 		void setArea(INT32 x, INT32 y, UINT32 width, UINT32 height);
 
+		/**
+		 * @brief	Adds a new menu item to the menu bar. 
+		 *
+		 * @param	path		Path to the menu item. Each element of the path must be separated using "/". 
+		 *						First element of the path will create the top level menu, and any further element
+		 *						will create a new sub-menu. Last element will be the interactable element.
+		 * @param	callback	Callback to trigger when user click on the interactable element (last element in the provided path).
+		 *						Can be null.
+		 * @param	priority	Determines where is the element positioned compared to other elements in the same sub-menu.
+		 *						Higher priority elements get placed higher up in the sub-menu. This only applies to the last
+		 *						element. If you need to customize its parent element priority call this method with
+		 *						with their specific paths.
+		 * @param	shortcut	Keyboard shortcut key to display next to the interactable element, and register with the
+		 *						global shortcut manager.
+		 */
 		const GUIMenuItem* addMenuItem(const WString& path, std::function<void()> callback, INT32 priority = 0, const ShortcutKey& shortcut = ShortcutKey::NONE);
+
+		/**
+		 * @brief	Adds a separator element at the specified path. The separator is added as a child of the path.
+		 *
+		 * @param	path		Parent path of the sub-menu to add the separator.
+		 * @param	priority	Determines where is the separator positioned compared to other elements in the same sub-menu.
+		 *						Higher priority elements get placed higher up in the sub-menu.
+		 */
 		const GUIMenuItem* addSeparator(const WString& path, INT32 priority = 0);
+
+		/**
+		 * @brief	Returns an existing menu item at the specified path, or null if one cannot be found.
+		 */
 		const GUIMenuItem* getMenuItem(const WString& path) const;
+
+		/**
+		 * @brief	Removes a menu item from the specified path. If this path points to a sub-menu entire sub-menu will be removed.
+		 */
 		void removeMenuItem(const WString& path);
 	private:
 		static const UINT32 NUM_ELEMENTS_AFTER_CONTENT;
@@ -45,8 +96,14 @@ namespace BansheeEngine
 		GUIButton* mSubMenuButton;
 		bool mSubMenuOpen;
 
+		/**
+		 * @brief	Finds a top level sub-menu with the specified name.
+		 */
 		const GUIMenuBarData* getSubMenu(const WString& name) const;
 
+		/**
+		 * @brief	Adds a new top level sub-menu button.
+		 */
 		GUIMenuBarData* addNewButton(const WString& name);
 
 		/**
@@ -58,19 +115,63 @@ namespace BansheeEngine
 		 */
 		bool stripPath(WString& path, WString& pathRoot) const;
 
+		/**
+		 * @brief	Registers a shortcut with the global shortcut manager. Pressing the shortcut will trigger
+		 *			the provided callback.
+		 */
 		void registerShortcut(const WString& path, const ShortcutKey& shortcut, std::function<void()> callback);
+
+		/**
+		 * @brief	Unregisters a shortcut assigned to the provided path from the global shortcut manager.
+		 */
 		void unregisterShortcut(const WString& path);
 
+		/**
+		 * @brief	Opens a top level sub-menu with the provided name.
+		 */
 		void openSubMenu(const WString& name);
+
+		/**
+		 * @brief	Closes any currently active sub-menu.
+		 */
 		void closeSubMenu();
 
+		/**
+		 * @brief	Triggered when a sub-menu is open and a user hovers over another
+		 *			top level sub-menu button
+		 *
+		 * @param	name	Name of the sub-menu the user is hovering over.
+		 */
 		void onSubMenuHover(const WString& name);
+
+		/**
+		 * @brief	Triggered when a sub-menu is closed.
+		 */
 		void onSubMenuClosed();
 
+		/**
+		 * @brief	Triggered when the minimize button is clicked.
+		 *			Minimizes the attached window.
+		 */
 		void onMinimizeClicked();
+
+		/**
+		 * @brief	Triggered when the maximize button is clicked.
+		 *			Maximizes the attached window.
+		 */
 		void onMaximizeClicked();
+
+		/**
+		 * @brief	Triggered when the close button is clicked.
+		 *			Closes the attached window.
+		 */
 		void onCloseClicked();
 
+		/**
+		 * @brief	Refreshes the OS client area that allow the window to be dragged
+		 *			by dragging the empty areas on the menu bar. Should be called when top
+		 *			level button configuration changes or menu bar area changes.
+		 */
 		void refreshNonClientAreas();
 	};
 }

BansheeEditor/Include/BsGUIResourceTreeView.h

@@ -8,19 +8,33 @@
 
 namespace BansheeEngine
 {
+	/**
+	 * @brief	Contains paths to resources currently involved
+	 *			in a drag and drop operation.
+	 */
 	struct DraggedResources
 	{
 		Vector<Path> resourcePaths;
 	};
 
+	/**
+	 * @brief	GUI element that displays all resources in the active project in a tree view.
+	 */
 	class GUIResourceTreeView : public GUITreeView
 	{
+		/**
+		 * @brief	Tree element with resource-specific data.
+		 */
 		struct ResourceTreeElement : public GUITreeView::TreeElement
 		{
 			Path mFullPath;
 			WString mElementName;
 		};
 
+		/**
+		 * @brief	Contains paths to resources currently involved
+		 *			in a drag and drop operation initiated by this tree view.
+		 */
 		struct InternalDraggedResources
 		{
 			InternalDraggedResources(UINT32 numObjects);
@@ -31,24 +45,62 @@ namespace BansheeEngine
 		};
 
 	public:
+		/**
+		 * Returns type name of the GUI element used for finding GUI element styles. 
+		 */
 		static const String& getGUITypeName();
 
+		/**
+		 * @brief	Creates a new resource tree view element.
+		 *
+		 * @param	backgroundStyle				Name of the style for the tree view background.
+		 * @param	elementBtnStyle				Name of the style for a normal tree view element.
+		 * @param	foldoutBtnStyle				Name of the style for a foldout element (e.g. for a folder).
+		 * @param	selectionBackgroundStyle	Name of the style for the background of selected elements.
+		 * @param	editBoxStyle				Name of the style for element that is being renamed.
+		 * @param	dragHighlightStyle			Name of the style for the element being dragged over.
+		 * @param	dragSepHighlightStyle		Name of the style for the separator displayed while dragging
+		 *										an element between two other elements.
+		 */	
 		static GUIResourceTreeView* create(
 			const String& backgroundStyle = StringUtil::BLANK, const String& elementBtnStyle = StringUtil::BLANK, 
 			const String& foldoutBtnStyle = StringUtil::BLANK, const String& selectionBackgroundStyle = StringUtil::BLANK,
 			const String& editBoxStyle = StringUtil::BLANK, const String& dragHighlightStyle = StringUtil::BLANK, 
 			const String& dragSepHighlightStyle = StringUtil::BLANK);
 
+		/**
+		 * @brief	Creates a new resource tree view element.
+		 *
+		 * @param	options						Options that allow you to control how is the element positioned and sized.
+		 *										This will override any similar options set by style.
+		 * @param	backgroundStyle				Name of the style for the tree view background.
+		 * @param	elementBtnStyle				Name of the style for a normal tree view element.
+		 * @param	foldoutBtnStyle				Name of the style for a foldout element (e.g. for a folder).
+		 * @param	selectionBackgroundStyle	Name of the style for the background of selected elements.
+		 * @param	editBoxStyle				Name of the style for element that is being renamed.
+		 * @param	dragHighlightStyle			Name of the style for the element being dragged over.
+		 * @param	dragSepHighlightStyle		Name of the style for the separator displayed while dragging
+		 *										an element between two other elements.
+		 */	
 		static GUIResourceTreeView* create(const GUIOptions& options, 
 			const String& backgroundStyle = StringUtil::BLANK, const String& elementBtnStyle = StringUtil::BLANK, 
 			const String& foldoutBtnStyle = StringUtil::BLANK, const String& selectionBackgroundStyle = StringUtil::BLANK,
 			const String& editBoxStyle = StringUtil::BLANK, const String& dragHighlightStyle = StringUtil::BLANK, 
 			const String& dragSepHighlightStyle = StringUtil::BLANK);
 
+		/**
+		 * @brief	Returns a list of paths of currently selected resources (if any).
+		 *			Returned paths are relative to the project folder.
+		 */	
 		Vector<Path> getSelection() const;
+
+		/**
+		 * @brief	Changes the active selection to the provided resources.
+		 *			Paths can be absolute or relative.
+		 */	
 		void setSelection(const Vector<Path>& paths);
 
-		Event<void()> onSelectionChanged;
+		Event<void()> onSelectionChanged; /**< Triggered whenever the selection changes. Call ::getSelection() to retrieve new selection: */
 		static const MessageId SELECTION_CHANGED_MSG;
 
 	protected:
@@ -70,40 +122,150 @@ namespace BansheeEngine
 			const String& foldoutBtnStyle, const String& selectionBackgroundStyle, const String& editBoxStyle, 
 			const String& dragHighlightStyle, const String& dragSepHighlightStyle, const GUIDimensions& dimensions);
 
-		virtual void _updateLayoutInternal(const GUILayoutData& data);
+		/**
+		 * @copydoc	GUITreeView::_updateLayoutInternal
+		 */	
+		virtual void _updateLayoutInternal(const GUILayoutData& data) override;
+
+		/**
+		 * @copydoc	GUITreeView::getRootElement
+		 */	
+		virtual TreeElement& getRootElement() override { return mRootElement; }
+
+		/**
+		 * @copydoc	GUITreeView::getRootElementConst
+		 */	
+		virtual const TreeElement& getRootElementConst() const override { return mRootElement; }
+
+		/**
+		 * @copydoc	GUITreeView::updateTreeElementHierarchy
+		 */	
+		virtual void updateTreeElementHierarchy() override;
+
+		/**
+		 * @copydoc	GUITreeView::renameTreeElement
+		 */	
+		virtual void renameTreeElement(TreeElement* element, const WString& name) override;
+
+		/**
+		 * @copydoc	GUITreeView::deleteTreeElement
+		 */	
+		virtual void deleteTreeElement(TreeElement* element) override;
+
+		/**
+		 * @copydoc	GUITreeView::acceptDragAndDrop
+		 */	
+		virtual bool acceptDragAndDrop() const override;
+
+		/**
+		 * @copydoc	GUITreeView::dragAndDropStart
+		 */	
+		virtual void dragAndDropStart() override;
+
+		/**
+		 * @copydoc	GUITreeView::dragAndDropEnded
+		 */	
+		virtual void dragAndDropEnded(TreeElement* overTreeElement) override;
+
+		/**
+		 * @copydoc	GUITreeView::dragAndDropFinalize
+		 */	
+		virtual void dragAndDropFinalize() override;
 
-		virtual TreeElement& getRootElement() { return mRootElement; }
-		virtual const TreeElement& getRootElementConst() const { return mRootElement; }
-		virtual void updateTreeElementHierarchy();
-		virtual void renameTreeElement(TreeElement* element, const WString& name);
-		virtual void deleteTreeElement(TreeElement* element);
-		virtual bool acceptDragAndDrop() const;
-		virtual void dragAndDropStart();
-		virtual void dragAndDropEnded(TreeElement* overTreeElement);
-		virtual void dragAndDropFinalize();
-		virtual bool _acceptDragAndDrop(const Vector2I position, UINT32 typeId) const;
-		virtual void selectionChanged();
+		/**
+		 * @copydoc	GUITreeView::_acceptDragAndDrop
+		 */	
+		virtual bool _acceptDragAndDrop(const Vector2I position, UINT32 typeId) const override;
 
+		/**
+		 * @copydoc	GUITreeView::selectionChanged
+		 */	
+		virtual void selectionChanged() override;
+
+		/**
+		 * @copydoc	GUITreeView::_changeParentWidget
+		 */	
+		void _changeParentWidget(GUIWidget* widget) override;
+
+		/**
+		 * @brief	Updates the contents of the provided tree entry with a project library entry.
+		 */
 		void updateFromProjectLibraryEntry(ResourceTreeElement* treeElement, const ProjectLibrary::LibraryEntry* libraryEntry);
+
+		/**
+		 * @brief	Creates a new tree view entry.
+		 *
+		 * @param	parent		Parent tree view entry to create the new one for.
+		 * @param	fullPath	Absolute path to the new tree entry.
+		 */
 		ResourceTreeElement* addTreeElement(ResourceTreeElement* parent, const Path& fullPath);
+
+		/**
+		 * @brief	Deletes the provided tree element.
+		 */
 		void deleteTreeElement(ResourceTreeElement* element);
+
+		/**
+		 * @brief	Sorts the children of the provided tree element by name.
+		 */
 		void sortTreeElement(ResourceTreeElement* element);
 
+		/**
+		 * @brief	Attempts to find a tree element with the specified path.
+		 *			Returns null if one cannot be found.
+		 */
 		ResourceTreeElement* findTreeElement(const Path& fullPath);
 
-		void entryAdded(const Path& path);
+		/**
+		 * @brief	Called whenever a new entry is added to the project library.
+		 */
+		void entryAdded(const Path& path); 
+
+		/**
+		 * @brief	Called whenever an entry is removed from the project library.
+		 */
 		void entryRemoved(const Path& path);
 
+		/**
+		 * @brief	Sets an OS drag and drop target that allows this element to receive OS-specific
+		 *			drag and drop events originating from other processes.
+		 */
 		void setDropTarget(RenderWindow* parentWindow, INT32 x, INT32 y, UINT32 width, UINT32 height);
+
+		/**
+		 * @brief	Removes the currently set OS drop target.
+		 */
 		void clearDropTarget();
 
+		/**
+		 * @brief	Triggered whenever the user drags the pointer over the set drop target,
+		 *			while OS drag and drop operation is active.
+		 *
+		 * @param	x	X coordinate of the pointer, relative to drop area.
+		 * @param	y	Y coordinate of the pointer, relative to drop area.
+		 */
 		void dropTargetDragMove(INT32 x, INT32 y);
+
+		/**
+		 * @brief	Triggered whenever pointer leaves the drop target,
+		 *			while OS drag and drop operation is active.
+		 */
 		void dropTargetDragLeave();
+
+		/**
+		 * @brief	Triggered whenever the user releases the pointer over the set drop target,
+		 *			while OS drag and drop operation is active.
+		 *
+		 * @param	x	X coordinate of the pointer, relative to drop area.
+		 * @param	y	Y coordinate of the pointer, relative to drop area.
+		 */
 		void dropTargetDragDropped(INT32 x, INT32 y);
 
+		/**
+		 * @brief	Generates a unique path in the case that something already
+		 *			exists on the provided one.
+		 */
 		Path findUniquePath(const Path& path);
-
-		void _changeParentWidget(GUIWidget* widget);
 	};
 
 	typedef ServiceLocator<GUIResourceTreeView> ResourceTreeViewLocator;