- Commented file

git-svn-id: svn://svn.gna.org/svn/sgpemv2/trunk@411 3ecf2c5c-341e-0410-92b4-d18e462d057c

src/standard_io.hh

@@ -35,15 +35,32 @@ namespace sgpem {
   class StandardIO;
     
   /**
-  
+    Concrete subclass of \ref IOManager implemented using
+    standard input and standard output.
   */
   class StandardIO : public IOManager 
   {
    public:
 
-    uint 			write_buffer(const Glib::ustring& buffer);
+    /**
+      Prints the parameter to standard output.
+      \param buffer The string to print.
+      \return The number of printed characters.
+     */
+    uint		write_buffer(const Glib::ustring& buffer);
+    
+    /**
+      Reads from standard input a command.
+      Whitespaces are trimmed at the beginning and at the end.
+      \return The command string, trimmed of whitespaces.
+     */
     Glib::ustring	read_command();
-	bool			is_full_duplex();
+
+    /**
+      Returns wheter this device can simultaneously read and write.
+      \return true if the device can read and write simultaneously, false otherwise.
+     */
+    bool		is_full_duplex();
   };
 
 }