remove misleading documentation of minPage in GetPageInfo() (see ticket #9502)

[wxWidgets.git] / interface / module.h

diff --git a/interface/module.h b/interface/module.h
index a579f08498f352fe576866b924c064b0773c06aa..ec801b608e0e3e9cf8e9998c82a191f662db8b7f 100644 (file)
--- a/interface/module.h
+++ b/interface/module.h
@@ -1,6 +1,6 @@
 /////////////////////////////////////////////////////////////////////////////
 // Name:        module.h
-// Purpose:     documentation for wxModule class
+// Purpose:     interface of wxModule
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Licence:     wxWindows license
@@ -9,23 +9,23 @@
 /**
     @class wxModule
     @wxheader{module.h}
-    
+
     The module system is a very simple mechanism to allow applications (and parts
     of wxWidgets itself) to define initialization and cleanup functions that are
     automatically called on wxWidgets startup and exit.
-    
+
     To define a new kind of module, derive a class from wxModule, override the
-    wxModule::OnInit and wxModule::OnExit 
+    wxModule::OnInit and wxModule::OnExit
     functions, and add the DECLARE_DYNAMIC_CLASS and IMPLEMENT_DYNAMIC_CLASS to
     header and implementation files (which can be the same file). On
     initialization, wxWidgets will find all classes derived from wxModule, create
     an instance of each, and call each OnInit function. On exit, wxWidgets will
     call the OnExit function for each module instance.
-    
+
     Note that your module class does not have to be in a header file.
-    
+
     For example:
-    
+
     @code
     // A module to allow DDE initialization/cleanup
       // without calling these functions from app.cpp or from
@@ -36,13 +36,13 @@
           wxDDEModule() { }
           virtual bool OnInit() { wxDDEInitialize(); return @true; };
           virtual void OnExit() { wxDDECleanUp(); };
-    
+
       private:
           DECLARE_DYNAMIC_CLASS(wxDDEModule)
       };
-    
+
       IMPLEMENT_DYNAMIC_CLASS(wxDDEModule, wxModule)
-    
+
       // Another module which uses DDE in its OnInit()
       class MyModule: public wxModule
       {
@@ -50,13 +50,13 @@
           MyModule() { AddDependency(CLASSINFO(wxDDEModule)); }
           virtual bool OnInit() { ... code using DDE ... }
           virtual void OnExit() { ... }
-    
+
       private:
           DECLARE_DYNAMIC_CLASS(MyModule)
       };
-    
+
       IMPLEMENT_DYNAMIC_CLASS(MyModule, wxModule)
-    
+
       // Another module which uses DDE in its OnInit()
       // but uses a named dependency
       class MyModule2: public wxModule
@@ -65,14 +65,14 @@
           MyModule2() { AddDependency("wxDDEModule"); }
           virtual bool OnInit() { ... code using DDE ... }
           virtual void OnExit() { ... }
-    
+
       private:
           DECLARE_DYNAMIC_CLASS(MyModule2)
       };
-    
+
       IMPLEMENT_DYNAMIC_CLASS(MyModule2, wxModule)
     @endcode
-    
+
     @library{wxbase}
     @category{FIXME}
 */
@@ -91,27 +91,24 @@ public:
 
     //@{
     /**
-        Call this function from the constructor of the derived class. @e dep must be
-        the CLASSINFO of a wxModule-derived class and the
+        Call this function from the constructor of the derived class. @a dep must be
+        the CLASSINFO() of a wxModule-derived class and the
         corresponding module will be loaded before and unloaded after
         this module.
-        
         The second version of this function allows a dependency to be added by
         name without access to the class info.  This is useful when a module is
         declared entirely in a source file and there is no header for the declaration
-        of the module needed by CLASSINFO, however errors are
+        of the module needed by CLASSINFO(), however errors are
         not detected until run-time, instead of compile-time, then.
-        
         Note that circular dependencies are detected and result in a fatal error.
-        
-        @param dep 
-        The class information object for the dependent module.
-        
-        @param classname 
-        The class name of the dependent module.
+
+        @param dep
+            The class information object for the dependent module.
+        @param classname
+            The class name of the dependent module.
     */
-    void AddDependency(wxClassInfo * dep);
-        void AddDependency(const char * classname);
+    void AddDependency(wxClassInfo* dep);
+    void AddDependency(const char* classname);
     //@}
 
     /**
@@ -126,3 +123,4 @@ public:
     */
     virtual bool OnInit();
 };
+