]> git.saurik.com Git - wxWidgets.git/blobdiff - interface/wizard.h
replace @b Note with @note; replace '' with "
[wxWidgets.git] / interface / wizard.h
index ab869ad39d1bd26a2a2ca865085b9bebd271cca7..8225b2f6d9cc43b2569bd557a4287ef9611ca5c0 100644 (file)
@@ -1,6 +1,6 @@
 /////////////////////////////////////////////////////////////////////////////
 // Name:        wizard.h
-// Purpose:     documentation for wxWizardPage class
+// Purpose:     interface of wxWizardPage
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Licence:     wxWindows license
@@ -24,8 +24,7 @@
     @library{wxadv}
     @category{miscwnd}
 
-    @seealso
-    wxWizard, @ref overview_samplewizard "wxWizard sample"
+    @see wxWizard, @ref overview_samplewizard "wxWizard sample"
 */
 class wxWizardPage : public wxPanel
 {
@@ -35,7 +34,7 @@ public:
         instead of the default one for this wizard (note that all bitmaps used should
         be of the same size). Notice that no other parameters are needed because the
         wizard will resize and reposition the page anyhow.
-        
+
         @param parent
             The parent wizard
         @param bitmap
@@ -60,7 +59,7 @@ public:
         button: if @NULL is returned, this button will be disabled. The last
         page of the wizard will usually return @NULL from here, but the others
         will not.
-        
+
         @see GetPrev()
     */
     wxWizardPage* GetNext() const;
@@ -70,26 +69,26 @@ public:
         button: if @NULL is returned, this button will be disabled. The first
         page of the wizard will usually return @NULL from here, but the others
         will not.
-        
+
         @see GetNext()
     */
     wxWizardPage* GetPrev() const;
 };
 
 
+
 /**
     @class wxWizardEvent
     @wxheader{wizard.h}
 
     wxWizardEvent class represents an event generated by the
-    wizard: this event is first sent to the page itself and,
+    wizard(): this event is first sent to the page itself and,
     if not processed there, goes up the window hierarchy as usual.
 
     @library{wxadv}
     @category{events}
 
-    @seealso
-    wxWizard, @ref overview_samplewizard "wxWizard sample"
+    @see wxWizard, @ref overview_samplewizard "wxWizard sample"
 */
 class wxWizardEvent : public wxNotifyEvent
 {
@@ -118,6 +117,7 @@ public:
 };
 
 
+
 /**
     @class wxWizardPageSimple
     @wxheader{wizard.h}
@@ -134,8 +134,7 @@ public:
     @library{wxadv}
     @category{miscwnd}
 
-    @seealso
-    wxWizard, @ref overview_samplewizard "wxWizard sample"
+    @see wxWizard, @ref overview_samplewizard "wxWizard sample"
 */
 class wxWizardPageSimple : public wxWizardPage
 {
@@ -169,6 +168,7 @@ public:
 };
 
 
+
 /**
     @class wxWizard
     @wxheader{wizard.h}
@@ -207,8 +207,7 @@ public:
     @library{wxadv}
     @category{cmndlg}
 
-    @seealso
-    wxWizardEvent, wxWizardPage, @ref overview_samplewizard "wxWizard sample"
+    @see wxWizardEvent, wxWizardPage, @ref overview_samplewizard "wxWizard sample"
 */
 class wxWizard : public wxDialog
 {
@@ -221,7 +220,7 @@ public:
         parameter in the wxWizard constructor because the wizard will have a predefined
         default size by default. If you want to change this, you should use the
         GetPageAreaSizer() function.
-        
+
         @param parent
             The parent window, may be @NULL.
         @param id
@@ -252,7 +251,7 @@ public:
         parameter in the wxWizard constructor because the wizard will have a predefined
         default size by default. If you want to change this, you should use the
         GetPageAreaSizer() function.
-        
+
         @param parent
             The parent window, may be @NULL.
         @param id
@@ -362,7 +361,7 @@ public:
         class version implements this by calling
         @ref wxWizardPage::getnext page-GetNext but this could be undesirable if,
         for example, the pages are created on demand only.
-        
+
         @see HasPrevPage()
     */
     virtual bool HasNextPage(wxWizardPage* page);
@@ -372,7 +371,7 @@ public:
         class version implements this by calling
         @ref wxWizardPage::getprev page-GetPrev but this could be undesirable if,
         for example, the pages are created on demand only.
-        
+
         @see HasNextPage()
     */
     virtual bool HasPrevPage(wxWizardPage* page);
@@ -403,34 +402,34 @@ public:
         page height. By default, placement is 0 (no expansion is done). @a placement is
         a bitlist with the
         following possible values:
-        
+
         @b wxWIZARD_VALIGN_TOP
-        
+
         Aligns the bitmap at the top.
-        
+
         @b wxWIZARD_VALIGN_CENTRE
-        
+
         Centres the bitmap vertically.
-        
+
         @b wxWIZARD_VALIGN_BOTTOM
-        
+
         Aligns the bitmap at the bottom.
-        
+
         @b wxWIZARD_HALIGN_LEFT
-        
+
         Left-aligns the bitmap.
-        
+
         @b wxWIZARD_HALIGN_CENTRE
-        
+
         Centres the bitmap horizontally.
-        
+
         @b wxWIZARD_HALIGN_RIGHT
-        
+
         Right-aligns the bitmap.
-        
+
         @b wxWIZARD_TILE
-        
-        
+
+
         See also SetMinimumBitmapWidth().
     */
     void SetBitmapPlacement(int placement);
@@ -471,3 +470,4 @@ public:
     */
     void SetPageSize(const wxSize& sizePage);
 };
+