From 924896ca0bd0b22b7efeba1bed31df0a57c33cb8 Mon Sep 17 00:00:00 2001
From: jinx <jinx@3ecf2c5c-341e-0410-92b4-d18e462d057c>
Date: Fri, 24 Feb 2006 01:33:06 +0000
Subject: [PATCH] Added some comments to the source code

git-svn-id: svn://svn.gna.org/svn/sgpemv2/trunk@422 3ecf2c5c-341e-0410-92b4-d18e462d057c
---
 src/graphical_simulation.hh | 6 +++---
 src/io_manager.hh           | 4 ++--
 src/main_window.hh          | 4 ++--
 src/start_gui.hh            | 4 +++-
 4 files changed, 10 insertions(+), 8 deletions(-)

diff --git a/src/graphical_simulation.hh b/src/graphical_simulation.hh
index 04535f9..33c6812 100644
--- a/src/graphical_simulation.hh
+++ b/src/graphical_simulation.hh
@@ -38,9 +38,9 @@ namespace sgpem {
   
   class GraphicalSimulation;
   
-  /** \brief This class represent the MAIN PROGRAM WINDOW
-   * 
-   * ... long desc ... */
+  /** \brief Concrete \ref Simulation subclass with a GUI. 
+      The GraphicalSimulation class is only a placeholder for the future baselines.  
+   */
   class GraphicalTerminalIO : public IOManager, public Gtk::Window
   {
     
diff --git a/src/io_manager.hh b/src/io_manager.hh
index 510b22e..a6eb06d 100644
--- a/src/io_manager.hh
+++ b/src/io_manager.hh
@@ -30,7 +30,7 @@ namespace sgpem {
     
   class IOManager;
     
-  /**
+  /** \brief Class IOManager is an interface for controlling textual I/O.
   
   */
   class IOManager 
@@ -39,7 +39,7 @@ namespace sgpem {
     virtual ~IOManager() {}
    	
     /**Writes a string into an output (the console, a text widget, ...)
-       \returns the number of charaters written
+       \returns the number of written characters
     */
     virtual uint			write_buffer(const Glib::ustring& buffer) = 0;
 	
diff --git a/src/main_window.hh b/src/main_window.hh
index 8b8c0a9..5f21c9d 100644
--- a/src/main_window.hh
+++ b/src/main_window.hh
@@ -34,10 +34,10 @@ namespace sgpem {
   
   // ---------------------------------------------
   
-  /** \brief The main program window
+  /** \brief The class represents main window of the program
    * 
    * This is the main simulation window displayed 
-   *  when the program is run with a GUI */
+   *  when the program is running in a GUI mode*/
   class MainWindow : public Gtk::Window 
   {
   public:
diff --git a/src/start_gui.hh b/src/start_gui.hh
index 0466d77..a6fa147 100644
--- a/src/start_gui.hh
+++ b/src/start_gui.hh
@@ -26,7 +26,9 @@
 #include "text_simulation.hh"
 
 
-/** \brief This function starts the whole GUI */
+/** \brief This function initialize and starts the whole GUI 
+
+*/
 void SG_DLLEXPORT start_gui(int argc, char** argv, TextSimulation& txt);
 
 #endif