Added some comments to the source code

git-svn-id: svn://svn.gna.org/svn/sgpemv2/trunk@422 3ecf2c5c-341e-0410-92b4-d18e462d057c
This commit is contained in:
jinx 2006-02-24 01:33:06 +00:00
parent 47c184ac3f
commit 924896ca0b
4 changed files with 10 additions and 8 deletions

View File

@ -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
{

View File

@ -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;

View File

@ -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:

View File

@ -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