started inline documentation

1 files changed, 28 insertions, 7 deletions

diff --git a/src/fbgui.h b/src/fbgui.h
index d385426..4ad17df 100644
--- a/src/fbgui.h
+++ b/src/fbgui.h
@@ -51,32 +51,53 @@ public:
 	fbgui();
 
 private:
-	// layout setup
+	//-------------------
+	//   layout setup:
+	//-------------------
+	// Sets the layout depending on the debug mode:
+	//   no debug or debugMode = 0 -> only browser shown.
+	//   debugMode = 1             -> split main window in browser and debug console.
 	void setupLayout();
+	// Create all actions for the GUI. (Currently only quit.)
 	void createActions();
-    // debug console setup
+	// Create a debug console widget as QTextEdit in order to print debug messages
+	// directly within the GUI. This was needed since ttys can't really be used
+	// for debugging purposes in the preboot environment.
     void createDebugConsole();
 
-	// functions to control the loading of baseURL
+    //----------------------------------------
+	//   control the display of components:
+    //----------------------------------------
+    // watches for the file triggering the loading of the URL.
+    // the file can be specified by the corresponding option.
 	void watchForTrigger();
 	bool checkHost() const;
 	void loadURL();
 	QByteArray generatePOSTData();
 
-	// widgets constituing the gui
+	//----------------------------------
+	//   widgets constituing the gui:
+	//----------------------------------
+	// QWebView for displaying internet content
 	QWebView* _webView;
+	// QSplitter to split the main window in two resizable frames.
 	QSplitter* _splitter;
+	// QTextEdit implementing a minimalistic debug console.
 	QTextEdit* _debugConsole;
 
-	// action list
+	//------------------
+	//   action list:
+	//------------------
+	// closes the main window provoking the application to quit.
 	QAction* _quit;
+	// triggers toggleDebugConsole()
 	QAction* _toggleDebugConsole;
 
-	// watcher to detect changes in the observed directory
+	// watcher to detect changes in the observed directory.
 	QFileSystemWatcher* _watcher;
 
 private slots:
-	// action slots
+	// toggles debug console when action _toggleDebugConsole happens.
 	void toggleDebugConsole();
 
 	// checks if the change reported by _watcher is the one we are looking for