X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/8526afcb2c7111282861fbdd9d18aa8fa21156bf..36a0190ebd5bd9a7302f60f6dcd608b80574e21c:/interface/wx/wizard.h

diff --git a/interface/wx/wizard.h b/interface/wx/wizard.h
index ca6287f53a..954f73fcd8 100644
--- a/interface/wx/wizard.h
+++ b/interface/wx/wizard.h
@@ -2,7 +2,6 @@
 // Name:        wizard.h
 // Purpose:     interface of wxWizardPage, wxWizardEvent,
 // Author:      wxWidgets team
-// RCS-ID:      $Id$
 // Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
@@ -226,6 +225,28 @@ public:
                 wxWizardPage *next = NULL,
                 const wxBitmap& bitmap = wxNullBitmap);
 
+    /**
+        A helper chaining this page with the next one.
+
+        Notice that this method returns a reference to the next page, so the
+        calls to it can, in turn, be chained:
+
+        @code
+        wxWizardPageSimple* firstPage = new FirstPage;
+        (*firstPage).Chain(new SecondPage)
+                    .Chain(new ThirdPage)
+                    .Chain(new LastPage);
+        @endcode
+
+        This makes this method the simplest way to define the order of changes
+        in fully static wizards, i.e. in those where the order doesn't depend
+        on the choices made by the user in the wizard pages during run-time.
+
+        @param next A non-@NULL pointer to the next page.
+        @return Reference to @a next on which Chain() can be called again.
+
+        @since 2.9.5
+     */
     /**
         A convenience function to make the pages follow each other.
         Example: