restored wxWindow::Line/PageUp/Down docs

[wxWidgets.git] / interface / busyinfo.h

diff --git a/interface/busyinfo.h b/interface/busyinfo.h
index 450a1e9d5b028ef8c8b014a2841bdbbc574c0a26..97eeee288eb6ca0d8016756bada6e1a22c65f789 100644 (file)
--- a/interface/busyinfo.h
+++ b/interface/busyinfo.h
@@ -1,6 +1,6 @@
 /////////////////////////////////////////////////////////////////////////////
 // Name:        busyinfo.h
 /////////////////////////////////////////////////////////////////////////////
 // Name:        busyinfo.h

-// Purpose:     documentation for wxBusyInfo class
+// Purpose:     interface of wxBusyInfo

 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Licence:     wxWindows license
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Licence:     wxWindows license


@@ -17,27 +17,27 @@
     For example:
 
     @code
     For example:
 
     @code

-    wxBusyInfo wait("Please wait, working...");
+        wxBusyInfo wait("Please wait, working...");

 
 

-        for (int i = 0; i  100000; i++)
+        for (int i = 0; i < 100000; i++)

         {
             DoACalculation();
         }
     @endcode
 
         {
             DoACalculation();
         }
     @endcode
 

-    It works by creating a window in the constructor,
-    and deleting it in the destructor.
+    It works by creating a window in the constructor, and deleting it
+    in the destructor.

 
     You may also want to call wxTheApp-Yield() to refresh the window
     periodically (in case it had been obscured by other windows, for
     example) like this:
 
     @code
 
     You may also want to call wxTheApp-Yield() to refresh the window
     periodically (in case it had been obscured by other windows, for
     example) like this:
 
     @code

-    wxWindowDisabler disableAll;
+        wxWindowDisabler disableAll;

 
         wxBusyInfo wait("Please wait, working...");
 
 
         wxBusyInfo wait("Please wait, working...");
 

-        for (int i = 0; i  100000; i++)
+        for (int i = 0; i < 100000; i++)

         {
             DoACalculation();
 
         {
             DoACalculation();
 


@@ -47,27 +47,26 @@
     @endcode
 
     but take care to not cause undesirable reentrancies when doing it (see
     @endcode
 
     but take care to not cause undesirable reentrancies when doing it (see

-    wxApp::Yield for more details). The simplest way to do
-    it is to use wxWindowDisabler class as illustrated
-    in the above example.
+    wxApp::Yield for more details). The simplest way to do it is to use
+    wxWindowDisabler class as illustrated in the above example.

 
     @library{wxcore}
 
     @library{wxcore}

-    @category{FIXME}
+    @category{cmndlg}

 */
 class wxBusyInfo
 {
 public:
     /**
 */
 class wxBusyInfo
 {
 public:
     /**

-        Constructs a busy info window as child of @e parent and displays @e msg
-        in it.
-        
-        @b NB: If @e parent is not @NULL you must ensure that it is not
-        closed while the busy info is shown.
+        Constructs a busy info window as child of @a parent and displays @e msg in it.
+
+        @note If @a parent is not @NULL you must ensure that it is not
+              closed while the busy info is shown.

     */
     */

-    wxBusyInfo(const wxString& msg, wxWindow* parent = @NULL);
+    wxBusyInfo(const wxString& msg, wxWindow* parent = NULL);

 
     /**
         Hides and closes the window containing the information text.
     */
     ~wxBusyInfo();
 };
 
     /**
         Hides and closes the window containing the information text.
     */
     ~wxBusyInfo();
 };

+