revised other headers

[wxWidgets.git] / interface / protocol / protocol.h

diff --git a/interface/protocol/protocol.h b/interface/protocol/protocol.h
index 522c18a14bbf53681ebe0ce57fd90f2f98ebaa8e..43e6d9842ac2cee84b33c1285cadafc103f7ab47 100644 (file)
--- a/interface/protocol/protocol.h
+++ b/interface/protocol/protocol.h
@@ -1,6 +1,6 @@
 /////////////////////////////////////////////////////////////////////////////
 // Name:        protocol/protocol.h
-// Purpose:     documentation for wxProtocol class
+// Purpose:     interface of wxProtocol
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Licence:     wxWindows license
@@ -14,8 +14,7 @@
     @library{wxnet}
     @category{FIXME}
 
-    @seealso
-    wxSocketBase, wxURL
+    @see wxSocketBase, wxURL
 */
 class wxProtocol : public wxSocketClient
 {
@@ -35,55 +34,44 @@ public:
     /**
         Returns the last occurred error.
         
-        
         @b wxPROTO_NOERR
         
-        
         No error.
         
         @b wxPROTO_NETERR
         
-        
         A generic network error occurred.
         
         @b wxPROTO_PROTERR
         
-        
         An error occurred during negotiation.
         
         @b wxPROTO_CONNERR
         
-        
         The client failed to connect the server.
         
         @b wxPROTO_INVVAL
         
-        
         Invalid value.
         
         @b wxPROTO_NOHNDLR
         
-        
         .
         
         @b wxPROTO_NOFILE
         
-        
         The remote file doesn't exist.
         
         @b wxPROTO_ABRT
         
-        
         Last action aborted.
         
         @b wxPROTO_RCNCT
         
-        
         An error occurred during reconnection.
         
         @b wxPROTO_STREAM
         
-        
         Someone tried to send a command during a transfer.
     */
     wxProtocolError GetError();
@@ -96,12 +84,12 @@ public:
         You will be notified when the EOF is reached by an error.
         
         @returns Returns the initialized stream. You will have to delete it
-                   yourself once you don't use it anymore. The
-                   destructor closes the network connection.
+                 yourself once you don't use it anymore. The destructor
+                 closes the network connection.
         
-        @sa wxInputStream
+        @see wxInputStream
     */
-    wxInputStream * GetInputStream(const wxString& path);
+    wxInputStream* GetInputStream(const wxString& path);
 
     /**
         Tries to reestablish a previous opened connection (close and renegotiate
@@ -121,3 +109,4 @@ public:
     */
     void SetUser(const wxString& user);
 };
+