Finished review/fixes of GDI category of functions and macros.

[wxWidgets.git] / interface / minifram.h

diff --git a/interface/minifram.h b/interface/minifram.h
index 70c9cfa3f55c2218894f126bc4f13c1e109bd7cd..10aa4bf3fb11e079a2d05717bbf067a24f9431a5 100644 (file)
--- a/interface/minifram.h
+++ b/interface/minifram.h
@@ -1,6 +1,6 @@
 /////////////////////////////////////////////////////////////////////////////
 // Name:        minifram.h
 /////////////////////////////////////////////////////////////////////////////
 // Name:        minifram.h

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

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


@@ -9,15 +9,15 @@
 /**
     @class wxMiniFrame
     @wxheader{minifram.h}
 /**
     @class wxMiniFrame
     @wxheader{minifram.h}

-    
+

     A miniframe is a frame with a small title bar. It is suitable for floating
     toolbars that must not
     take up too much screen area.
     A miniframe is a frame with a small title bar. It is suitable for floating
     toolbars that must not
     take up too much screen area.

-    
+

     An example of mini frame can be seen in the @ref overview_sampledialogs
     An example of mini frame can be seen in the @ref overview_sampledialogs

-    "dialogs sample" 
+    "dialogs sample"

     using the "Mini frame'' command of the "Generic dialogs'' submenu.
     using the "Mini frame'' command of the "Generic dialogs'' submenu.

-    
+

     @beginStyleTable
     @style{wxICONIZE}:
            Display the frame iconized (minimized) (Windows only).
     @beginStyleTable
     @style{wxICONIZE}:
            Display the frame iconized (minimized) (Windows only).


@@ -44,12 +44,11 @@
     @style{wxRESIZE_BORDER}:
            Displays a resizeable border around the window.
     @endStyleTable
     @style{wxRESIZE_BORDER}:
            Displays a resizeable border around the window.
     @endStyleTable

-    
+

     @library{wxcore}
     @category{managedwnd}
     @library{wxcore}
     @category{managedwnd}

-    
-    @seealso
-    wxMDIParentFrame, wxMDIChildFrame, wxFrame, wxDialog
+
+    @see wxMDIParentFrame, wxMDIChildFrame, wxFrame, wxDialog

 */
 class wxMiniFrame : public wxFrame
 {
 */
 class wxMiniFrame : public wxFrame
 {


@@ -58,44 +57,40 @@ public:
     /**
         Constructor, creating the window.
         
     /**
         Constructor, creating the window.
         

-        @param parent 
-        The window parent. This may be @NULL. If it is non-@NULL, the frame will
-        always be displayed on top of the parent window on Windows.
-        
-        @param id 
-        The window identifier. It may take a value of -1 to indicate a default value.
-        
-        @param title 
-        The caption to be displayed on the frame's title bar.
-        
-        @param pos 
-        The window position. The value wxDefaultPosition indicates a default position, chosen by
-        either the windowing system or wxWidgets, depending on platform.
-        
-        @param size 
-        The window size. The value wxDefaultSize indicates a default size, chosen by
-        either the windowing system or wxWidgets, depending on platform.
-        
-        @param style 
-        The window style. See wxMiniFrame.
-        
-        @param name 
-        The name of the window. This parameter is used to associate a name with the
+        @param parent
+            The window parent. This may be @NULL. If it is non-@NULL, the frame will
+            always be displayed on top of the parent window on Windows.
+        @param id
+            The window identifier. It may take a value of -1 to indicate a default
+        value.
+        @param title
+            The caption to be displayed on the frame's title bar.
+        @param pos
+            The window position. The value wxDefaultPosition indicates a default position,
+        chosen by
+            either the windowing system or wxWidgets, depending on platform.
+        @param size
+            The window size. The value wxDefaultSize indicates a default size, chosen by
+            either the windowing system or wxWidgets, depending on platform.
+        @param style
+            The window style. See wxMiniFrame.
+        @param name
+            The name of the window. This parameter is used to associate a name with the

         item,
         item,

-        allowing the application user to set Motif resource values for
-        individual windows.
+            allowing the application user to set Motif resource values for
+            individual windows.

         
         @remarks The frame behaves like a normal frame on non-Windows platforms.
         
         
         @remarks The frame behaves like a normal frame on non-Windows platforms.
         

-        @sa Create()
+        @see Create()

     */
     wxMiniFrame();
     */
     wxMiniFrame();

-        wxMiniFrame(wxWindow* parent, wxWindowID id,
-                    const wxString& title,
-                    const wxPoint& pos = wxDefaultPosition,
-                    const wxSize& size = wxDefaultSize,
-                    long style = wxCAPTION | wxRESIZE_BORDER,
-                    const wxString& name = "frame");
+    wxMiniFrame(wxWindow* parent, wxWindowID id,
+                const wxString& title,
+                const wxPoint& pos = wxDefaultPosition,
+                const wxSize& size = wxDefaultSize,
+                long style = wxCAPTION | wxRESIZE_BORDER,
+                const wxString& name = "frame");

     //@}
 
     /**
     //@}
 
     /**


@@ -114,3 +109,4 @@ public:
                 long style = wxCAPTION | wxRESIZE_BORDER,
                 const wxString& name = "frame");
 };
                 long style = wxCAPTION | wxRESIZE_BORDER,
                 const wxString& name = "frame");
 };

+