Create dir for MSVC version source files. Update commentaries at source files.

[boost-statechart-viewer.git] / src / iooper.h

diff --git a/src/iooper.h b/src/iooper.h
index a8a891096a29918bef8b176e222b345aace933c1..a5bd254563a9bb09ed4797234f0bbd15a1c86807 100644 (file)
--- a/src/iooper.h
+++ b/src/iooper.h
@@ -1,4 +1,4 @@
-
+/** @file */ 
 ////////////////////////////////////////////////////////////////////////////////////////  
 //    
 //    This file is part of Boost Statechart Viewer.
@@ -30,14 +30,14 @@ using namespace std;
 * This class provides saving information about state machine to a specified output file. It saves states and transitions and also it creates the transition table.
 */
 class IO_operations
-{
-       list<string> transitions;
-       list<string> states;
-       list<string> events;
-       string outputFilename;
+{      
+       list<string> transitions; /** list of transitions */
+       list<string> states; /** list of states */
+       list<string> events; /** list of events */
+       string outputFilename; 
        string name_of_machine;
        string name_of_first_state;
-       string *table;
+       string *table; /** transition table. It is being allocated when starting the creation of output file. */
        int nState;
        int cols, rows;
        /** This function finds place in the transition table to put a transition there. */
@@ -58,7 +58,8 @@ class IO_operations
                return -1;
        }
        public:
-       IO_operations() {}
+       IO_operations() {} /** Implicit constructor */
+       /** Constructor that fill in all private variables in this class */
        IO_operations( const string outputFile, const string FSM_name, const string firstState, const list<string> trans, const list<string> state, const list<string> ev )
        {
                outputFilename = outputFile;
@@ -68,7 +69,8 @@ class IO_operations
                states = state;
                events = ev;
        }
-       ~IO_operations()
+
+       ~IO_operations() /** destructor. It deallocates the transition table.*/
        {
                delete table;
        }