More interface header reviews by Azriel Fasten, and added skeleton docs for wxBookCtr...

[wxWidgets.git] / interface / dcmirror.h

diff --git a/interface/dcmirror.h b/interface/dcmirror.h
index 7df4987c1b63fc51a48cbe28e8e80bdb80eddc4e..d15af962f04929ff0dc9b646995b21d3728c0451 100644 (file)
--- a/interface/dcmirror.h
+++ b/interface/dcmirror.h
@@ -1,6 +1,6 @@
 /////////////////////////////////////////////////////////////////////////////
 // Name:        dcmirror.h
-// Purpose:     documentation for wxMirrorDC class
+// Purpose:     interface of wxMirrorDC
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Licence:     wxWindows license
@@ -11,12 +11,12 @@
     @wxheader{dcmirror.h}
 
     wxMirrorDC is a simple wrapper class which is always associated with a real
-    wxDC object and either forwards all of its operations to it
-    without changes (no mirroring takes place) or exchanges @e x and @e y
-    coordinates which makes it possible to reuse the same code to draw a figure and
-    its mirror -- i.e. reflection related to the diagonal line x == y.
+    wxDC object and either forwards all of its operations to it without changes
+    (no mirroring takes place) or exchanges @e x and @e y coordinates which
+    makes it possible to reuse the same code to draw a figure and its mirror --
+    i.e. reflection related to the diagonal line x == y.
 
-    wxMirrorDC has been added in wxWidgets version 2.5.0.
+    @since 2.5.0
 
     @library{wxcore}
     @category{dc}
@@ -25,11 +25,13 @@ class wxMirrorDC : public wxDC
 {
 public:
     /**
-        Creates a (maybe) mirrored DC associated with the real @e dc. Everything
-        drawn on wxMirrorDC will appear (and maybe mirrored) on @e dc.
-        
-        @e mirror specifies if we do mirror (if it is @true) or not (if it is
+        Creates a (maybe) mirrored DC associated with the real @a dc.
+        Everything drawn on wxMirrorDC will appear (and maybe mirrored) on
+        @a dc.
+
+        @a mirror specifies if we do mirror (if it is @true) or not (if it is
         @false).
     */
     wxMirrorDC(wxDC& dc, bool mirror);
 };
+