From 05d4fd3c62df9debf78bba48c6c4d215e63f9e5e Mon Sep 17 00:00:00 2001
From: dfighter1985 <dfighter1985@localhost>
Date: Mon, 16 Jul 2012 07:15:40 +0200
Subject: [PATCH] CHANGED: #1471 Added some comments to the headers.

---
 code/nel/include/nel/gui/db_manager.h         | 24 +++++++++++++++++++
 code/nel/include/nel/gui/group_html.h         |  5 ++++
 code/nel/include/nel/gui/interface_parser.h   | 15 ++++++++----
 code/nel/include/nel/gui/lua_manager.h        | 14 ++++++++++-
 code/nel/include/nel/gui/parser.h             |  1 +
 code/nel/include/nel/gui/reflect_register.h   |  1 +
 code/nel/include/nel/gui/view_renderer.h      |  1 +
 code/nel/include/nel/gui/view_text_formated.h |  1 +
 code/nel/include/nel/gui/view_text_id.h       |  2 +-
 code/nel/include/nel/gui/widget_manager.h     | 12 +++++++++-
 10 files changed, 69 insertions(+), 7 deletions(-)

diff --git a/code/nel/include/nel/gui/db_manager.h b/code/nel/include/nel/gui/db_manager.h
index 38e75a755..72f665923 100644
--- a/code/nel/include/nel/gui/db_manager.h
+++ b/code/nel/include/nel/gui/db_manager.h
@@ -23,15 +23,39 @@
 namespace NLGUI
 {
 
+	/**
+	 Database Manager
+	 
+	 Provides access to a simple CDB based tree hierarchical data store
+	 */
 	class CDBManager : public NLMISC::CCDBManager
 	{
 	public:
 		static CDBManager* getInstance();
 		static void release();
 		
+		/**
+		 Retrieves a leaf node from the database.
+		 @param name   - name of the data leaf node we are querying.
+		 @param create - when true if a node cannot be found it is created.
+		 */
 		NLMISC::CCDBNodeLeaf* getDbProp( const std::string &name, bool create = true );
+
+		/**
+		 Deletes a node from the database.
+		 @param name  - name of the node.
+		 */
 		void delDbProp( const std::string &name );
+
+		/**
+		 Returns a leaf node's content as an sint32
+		 @param name  -  name of the leaf node.
+		 */
 		sint32 getDbValue32( const std::string &name );
+
+		/**
+		 Returns the root branch of the database.
+		 */
 		NLMISC::CCDBNodeBranch* getDB() const;
 	
 	private:
diff --git a/code/nel/include/nel/gui/group_html.h b/code/nel/include/nel/gui/group_html.h
index 3d0b641fd..44bad783f 100644
--- a/code/nel/include/nel/gui/group_html.h
+++ b/code/nel/include/nel/gui/group_html.h
@@ -63,12 +63,17 @@ namespace NLGUI
 		friend void TextEndUnparsedElement(HText *me, const char *buffer, int length);
 		friend int requestTerminater (HTRequest * request, HTResponse * response, void * param, int status);
 
+		/// Web browser options for CGroupHTML
 		struct SWebOptions
 		{
 		public:
+			/// Id of the browser ( e.g.: Chrome, Firefox, Ryzom )
 			std::string appName;
+			/// Version of the browser
 			std::string appVersion;
+			/// Language code of the browser( e.g.: en, hu )
 			std::string languageCode;
+			/// List of domains the widget can consider secure.
 			std::vector< std::string > trustedDomains;
 
 			SWebOptions()
diff --git a/code/nel/include/nel/gui/interface_parser.h b/code/nel/include/nel/gui/interface_parser.h
index 032884437..be333044c 100644
--- a/code/nel/include/nel/gui/interface_parser.h
+++ b/code/nel/include/nel/gui/interface_parser.h
@@ -53,15 +53,21 @@ namespace NLGUI
 
 	public:
 		
+		/// Interface for parser modules
+		/// Such modules can be plugged into CInterfaceParser, and
+		/// the modules then can parse GUI XMLs for widget classes that are not
+		/// generic enough to be in the GUI library.
 		class IParserModule
 		{
 		public:
+
+			/// Various parsing stages
 			enum ParsingStage
 			{
-				None			= 0,
-				Unresolved		= 1,
-				Resolved		= 2,
-				GroupChildren	= 4
+				None			= 0,  /// module cannot parse in any stage.
+				Unresolved		= 1,  /// module can parse in the first stage when styles, templates, etc have not been resolved yet
+				Resolved		= 2,  /// module can parse after resolving styles and templates
+				GroupChildren	= 4   /// module can parse when parsing the group children
 			};
 
 			IParserModule(){
@@ -86,6 +92,7 @@ namespace NLGUI
 			uint parsingStage;
 		};
 
+		/// Interface for event handlers which can be called when setting up the options.
 		class ISetupOptionCallbackClass
 		{
 		public:
diff --git a/code/nel/include/nel/gui/lua_manager.h b/code/nel/include/nel/gui/lua_manager.h
index 0f1eb3b3b..9044dfcd5 100644
--- a/code/nel/include/nel/gui/lua_manager.h
+++ b/code/nel/include/nel/gui/lua_manager.h
@@ -23,7 +23,11 @@ namespace NLGUI
 {
 	class CLuaState;
 
-	/// Provides a single global access point to the Lua state, and related stuff. :(
+	/**
+	 Lua Manager
+
+	 Provides a single global access point to the Lua state, and related stuff. :(
+	 */
 	class CLuaManager
 	{
 	public:
@@ -41,12 +45,20 @@ namespace NLGUI
 		/// Enables attaching the Lua debugger in the CLuaState instance, only matters on startup.
 		static void enableLuaDebugging(){ debugLua = true;	}
 
+		/// Returns the Lua state.
 		NLGUI::CLuaState* getLuaState() const{ return luaState; }
 
+		/**
+		 Executes a Lua script
+		 @param luaScript   -  the script we want to execute ( the actual script, not the filename! )
+		 @param smallScript -  true if the script is very small, so it can be cached for the possible next execution.
+		 */
 		bool executeLuaScript( const std::string &luaScript, bool smallScript = false );
 
+		/// Resets the Lua state, that is deallocates it and allocates a new one.
 		void ResetLuaState();
 
+		/// Forces the Garbage Collector to run.
 		void forceGarbageCollect();
 
 	private:
diff --git a/code/nel/include/nel/gui/parser.h b/code/nel/include/nel/gui/parser.h
index 5adfd0691..e032928c7 100644
--- a/code/nel/include/nel/gui/parser.h
+++ b/code/nel/include/nel/gui/parser.h
@@ -31,6 +31,7 @@ namespace NLGUI
 	class CCtrlSheetSelection;
 	class CInterfaceLink;
 
+	/// Interface for the GUI XML parser class.
 	class IParser
 	{
 	public:
diff --git a/code/nel/include/nel/gui/reflect_register.h b/code/nel/include/nel/gui/reflect_register.h
index 0d86cf262..96c1be798 100644
--- a/code/nel/include/nel/gui/reflect_register.h
+++ b/code/nel/include/nel/gui/reflect_register.h
@@ -20,6 +20,7 @@
 
 namespace NLGUI
 {
+	/// Helper class to register reflectable classes
 	class CReflectableRegister
 	{
 	public:
diff --git a/code/nel/include/nel/gui/view_renderer.h b/code/nel/include/nel/gui/view_renderer.h
index 83b45f79f..effe4fd70 100644
--- a/code/nel/include/nel/gui/view_renderer.h
+++ b/code/nel/include/nel/gui/view_renderer.h
@@ -580,6 +580,7 @@ namespace NLGUI
 	public:
 		static NL3D::UTextContext* getTextContext(){ return textcontext; }
 
+		/// Set of hw cursor images
 		static std::set< std::string > *hwCursors;
 		static float hwCursorScale;
 
diff --git a/code/nel/include/nel/gui/view_text_formated.h b/code/nel/include/nel/gui/view_text_formated.h
index dd9d1149a..884923d51 100644
--- a/code/nel/include/nel/gui/view_text_formated.h
+++ b/code/nel/include/nel/gui/view_text_formated.h
@@ -36,6 +36,7 @@ namespace NLGUI
 	{
 	public:
 
+		/// Interface for classes which can format the text for this view.
 		class IViewTextFormatter
 		{
 		public:
diff --git a/code/nel/include/nel/gui/view_text_id.h b/code/nel/include/nel/gui/view_text_id.h
index fea01f59c..5dd0808af 100644
--- a/code/nel/include/nel/gui/view_text_id.h
+++ b/code/nel/include/nel/gui/view_text_id.h
@@ -49,7 +49,7 @@ namespace NLGUI
 	{
 	public:
 		
-		/// Interface for classes that can provide text to CViewTextId
+		/// Interface for classes which can provide text to CViewTextId
 		class IViewTextProvider
 		{
 		public:
diff --git a/code/nel/include/nel/gui/widget_manager.h b/code/nel/include/nel/gui/widget_manager.h
index 8410bcc4a..5a29aa804 100644
--- a/code/nel/include/nel/gui/widget_manager.h
+++ b/code/nel/include/nel/gui/widget_manager.h
@@ -47,11 +47,16 @@ namespace NLGUI
 	class CInterfaceAnim;
 	class CProcedure;
 
-	/// Manages the GUI widgets
+	/**
+	 GUI Widget Manager
+
+	 Manages the GUI widgets, asks them to draw themselves, etc.
+	 */
 	class CWidgetManager{
 
 	public:
 
+		/// Interface for event handlers that can be called when the screen is resized.
 		class INewScreenSizeHandler
 		{
 		public:
@@ -59,6 +64,7 @@ namespace NLGUI
 			virtual void process( uint32 w, uint32 h ) = 0;
 		};
 
+		/// Interface for event handlers that can be called when the widgets finished drawing.
 		class IOnWidgetsDrawnHandler
 		{
 		public:
@@ -66,11 +72,15 @@ namespace NLGUI
 			virtual void process() = 0;
 		};
 
+		/// Frame render times
 		struct SInterfaceTimes
 		{
 		public:
+			/// Time when the last frame was rendered in ms.
 			sint64 lastFrameMs;
+			/// Time when the current frame was rendered in ms.
 			sint64 thisFrameMs;
+			/// Difference between the two times in ms.
 			sint64 frameDiffMs;
 
 			SInterfaceTimes()