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/dialup.h

@@ -43,10 +43,9 @@ public:
     /**
         Cancel dialing the number initiated with Dial()
         with async parameter equal to @true.
-        
         Note that this won't result in DISCONNECTED event being sent.
         
-        @sa IsDialing()
+        @see IsDialing()
     */
     bool CancelDialing();
 
@@ -58,28 +57,24 @@ public:
     wxDialUpManager* Create();
 
     /**
-        Dial the given ISP, use @e username and @e password to authenticate.
-        
+        Dial the given ISP, use @a username and @a password to authenticate.
         The parameters are only used under Windows currently, for Unix you should use
         SetConnectCommand() to customize this
         functions behaviour.
-        
-        If no @e nameOfISP is given, the function will select the default one
+        If no @a nameOfISP is given, the function will select the default one
         (proposing the user to choose among all connections defined on this machine)
         and if no username and/or password are given, the function will try to do
         without them, but will ask the user if really needed.
-        
-        If @e async parameter is @false, the function waits until the end of dialing
+        If @a async parameter is @false, the function waits until the end of dialing
         and returns @true upon successful completion.
-        
-        If @e async is @true, the function only initiates the connection and
+        If @a async is @true, the function only initiates the connection and
         returns immediately - the result is reported via events (an event is sent
         anyhow, but if dialing failed it will be a DISCONNECTED one).
     */
     bool Dial(const wxString& nameOfISP = wxEmptyString,
               const wxString& username = wxEmptyString,
               const wxString& password = wxEmptyString,
-              bool async = @true);
+              bool async = true);
 
     /**
         Disable automatic check for connection status change - notice that the
@@ -94,14 +89,12 @@ public:
         often should we repeat the check (each minute by default). Under Windows, the
         notification about the change of connection status is sent by the system and so
         we don't do any polling and this parameter is ignored.
-        
         Returns @false if couldn't set up automatic check for online status.
     */
     bool EnableAutoCheckOnlineStatus(size_t nSeconds = 60);
 
     /**
         This function is only implemented under Windows.
-        
         Fills the array with the names of all possible values for the first
         parameter to Dial() on this machine and returns
         their number (may be 0).
@@ -116,7 +109,6 @@ public:
     /**
         Returns @true if the computer has a permanent network connection (i.e. is
         on a LAN) and so there is no need to use Dial() function to go online.
-        
         @b NB: this functions tries to guess the result and it is not always
         guaranteed to be correct, so it is better to ask user for
         confirmation or give him a possibility to override it.
@@ -126,7 +118,7 @@ public:
     /**
         Returns @true if (async) dialing is in progress.
         
-        @sa Dial()
+        @see Dial()
     */
     bool IsDialing();
 
@@ -136,7 +128,7 @@ public:
         good idea to call this function and check its result before calling any other
         wxDialUpManager methods
     */
-#define bool IsOk()     /* implementation is private */
+    bool IsOk();
 
     /**
         Returns @true if the computer is connected to the network: under Windows,
@@ -148,9 +140,7 @@ public:
 
     /**
         , @b const wxString&@e commandHangup = wxT("/usr/bin/poff"))
-        
         This method is for Unix only.
-        
         Sets the commands to start up the network and to hang up again.
     */
     void SetConnectCommand();
@@ -161,13 +151,12 @@ public:
         allows to forcefully set the online status - whatever our internal
         algorithm may think about it.
         
-        @sa IsOnline()
+        @see IsOnline()
     */
-    void SetOnlineStatus(bool isOnline = @true);
+    void SetOnlineStatus(bool isOnline = true);
 
     /**
         This method is for Unix only.
-        
         Under Unix, the value of well-known host is used to check whether we're
         connected to the internet. It is unused under Windows, but this function
         is always safe to call. The default value is @c www.yahoo.com:80.