removed @NULL,@true,@false tags from the function prototypes; fixed * and & displacing in the prototypes; changed @param as discussed on wx-dev; use @see instead of @sa; better indentation for @returns,@remarks,@see paragraphs; other misc fixes

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@52407 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775

interface/url.h

@@ -32,59 +32,50 @@ public:
         to RFC 1738.  In particular, file URLs must be of the format
         @c file://hostname/path/to/file otherwise GetError()
         will return a value different from @c wxURL_NOERR.
-        
         It is valid to leave out the hostname but slashes must remain in place -
         i.e. a file URL without a hostname must contain three consecutive slashes
         (e.g. @c file:///somepath/myfile).
         
         @param url
-        Url string to parse.
+            Url string to parse.
     */
-#define wxURL(const wxString& url = wxEmptyString)     /* implementation is private */
+    wxURL(const wxString& url = wxEmptyString);
 
     /**
         Destroys the URL object.
     */
-#define ~wxURL()     /* implementation is private */
+    ~wxURL();
 
     /**
         Returns the last error. This error refers to the URL parsing or to the protocol.
         It can be one of these errors:
         
-        
         @b wxURL_NOERR
         
-        
         No error.
         
         @b wxURL_SNTXERR
         
-        
         Syntax error in the URL string.
         
         @b wxURL_NOPROTO
         
-        
         Found no protocol which can get this URL.
         
         @b wxURL_NOHOST
         
-        
         A host name is required for this protocol.
         
         @b wxURL_NOPATH
         
-        
         A path is required for this protocol.
         
         @b wxURL_CONNERR
         
-        
         Connection error.
         
         @b wxURL_PROTOERR
         
-        
         An error occurred during negotiation.
     */
     wxURLError GetError();
@@ -93,18 +84,16 @@ public:
         Creates a new input stream on the specified URL. You can use all but seek
         functionality of wxStream. Seek isn't available on all streams. For example,
         HTTP or FTP streams don't deal with it.
-        
         Note that this method is somewhat deprecated, all future wxWidgets applications
         should really use wxFileSystem instead.
-        
         Example:
         
         @returns Returns the initialized stream. You will have to delete it
-                   yourself.
+                 yourself.
         
-        @sa wxInputStream
+        @see wxInputStream
     */
-    wxInputStream * GetInputStream();
+    wxInputStream* GetInputStream();
 
     /**
         Returns a reference to the protocol which will be used to get the URL.
@@ -115,23 +104,23 @@ public:
         Returns @true if this object is correctly initialized, i.e. if
         GetError() returns @c wxURL_NOERR.
     */
-#define bool IsOk()     /* implementation is private */
+    bool IsOk();
 
     /**
         Sets the default proxy server to use to get the URL. The string specifies
         the proxy like this: hostname:port number.
         
         @param url_proxy
-        Specifies the proxy to use
+            Specifies the proxy to use
         
-        @sa SetProxy()
+        @see SetProxy()
     */
     static void SetDefaultProxy(const wxString& url_proxy);
 
     /**
         Sets the proxy to use for this URL.
         
-        @sa SetDefaultProxy()
+        @see SetDefaultProxy()
     */
     void SetProxy(const wxString& url_proxy);
 
@@ -139,5 +128,5 @@ public:
         Initializes this object with the given URL and returns @c wxURL_NOERR
         if it's valid (see GetError() for more info).
     */
-#define wxURLError SetURL(const wxString& url)     /* implementation is private */
+    wxURLError SetURL(const wxString& url);
 };