X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/328f5751e8a06727b137189fe04891a9f43bfc8b..14bdedbc67c490c8b168455bc726f092a950faea:/interface/dialup.h diff --git a/interface/dialup.h b/interface/dialup.h index 3605a60f07..2b72e9786b 100644 --- a/interface/dialup.h +++ b/interface/dialup.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: dialup.h -// Purpose: documentation for wxDialUpManager class +// Purpose: interface of wxDialUpManager // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -29,8 +29,7 @@ @library{wxcore} @category{net} - @seealso - @ref overview_sampledialup "dialup sample", wxDialUpEvent + @see @ref overview_sampledialup "dialup sample", wxDialUpEvent */ class wxDialUpManager { @@ -44,7 +43,7 @@ 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. - + @see IsDialing() */ bool CancelDialing(); @@ -109,7 +108,7 @@ 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 + @note 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. */ @@ -117,7 +116,7 @@ public: /** Returns @true if (async) dialing is in progress. - + @see Dial() */ bool IsDialing() const; @@ -150,7 +149,7 @@ public: so, in general, the user should be allowed to override it. This function allows to forcefully set the online status - whatever our internal algorithm may think about it. - + @see IsOnline() */ void SetOnlineStatus(bool isOnline = true); @@ -165,6 +164,7 @@ public: }; + /** @class wxDialUpEvent @wxheader{dialup.h} @@ -196,3 +196,4 @@ public: */ bool IsOwnEvent() const; }; +