make sure all wxDefault* and all wxNull* global instances are documented

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@53047 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775

diff --git a/interface/colour.h b/interface/colour.h
index e7ffbb84b94fc047ae44609a3fb1c3f090df7031..86b430e66fc705e5c0884f75875e45ac97dc45cc 100644 (file)
--- a/interface/colour.h
+++ b/interface/colour.h
@@ -164,7 +164,7 @@ public:
 
 
 /**
 
 
 /**

-    FIXME
+    An empty colour.

 */
 wxColour wxNullColour;
 
 */
 wxColour wxNullColour;
 

diff --git a/interface/cursor.h b/interface/cursor.h
index b4fca7a39b21a7d12cbf998cb94aec876c183b65..e812b591b9a3adab1725578d66db972278699e5e 100644 (file)
--- a/interface/cursor.h
+++ b/interface/cursor.h
@@ -28,8 +28,7 @@
     @category{gdi}
 
     @stdobjects
     @category{gdi}
 
     @stdobjects

-    ::Objects:, ::wxNullCursor, ::Pointers:, ::wxSTANDARD_CURSOR,
-    ::wxHOURGLASS_CURSOR, ::wxCROSS_CURSOR,
+    ::wxNullCursor, ::wxSTANDARD_CURSOR, ::wxHOURGLASS_CURSOR, ::wxCROSS_CURSOR

 
     @see wxBitmap, wxIcon, wxWindow::SetCursor, ::wxSetCursor
 */
 
     @see wxBitmap, wxIcon, wxWindow::SetCursor, ::wxSetCursor
 */


@@ -461,24 +460,11 @@ public:
     wxCursor operator =(const wxCursor& cursor);
 };
 
     wxCursor operator =(const wxCursor& cursor);
 };
 

-
-/**
-    FIXME
-*/
-wxCursor Objects:
-;
-

 /**
 /**

-    FIXME
+    An empty wxCursor.

 */
 wxCursor wxNullCursor;
 
 */
 wxCursor wxNullCursor;
 

-/**
-    FIXME
-*/
-wxCursor Pointers:
-;
-

 /**
     FIXME
 */
 /**
     FIXME
 */

diff --git a/interface/datetime.h b/interface/datetime.h
index a7a7af8749e1aba6459d1830de2647d964becd02..c388f0b0b8775eb1dbd59263dc61b8c5020da90a 100644 (file)
--- a/interface/datetime.h
+++ b/interface/datetime.h
@@ -15,6 +15,9 @@
     @library{wxbase}
     @category{data}
 
     @library{wxbase}
     @category{data}
 

+    @stdobjects
+    ::wxDefaultDateTime
+

     @see @ref overview_wxdatetimeoverview "Date classes overview", wxTimeSpan,
     wxDateSpan, wxCalendarCtrl
 */
     @see @ref overview_wxdatetimeoverview "Date classes overview", wxTimeSpan,
     wxDateSpan, wxCalendarCtrl
 */


@@ -1152,6 +1155,14 @@ public:
     wxDateTime operator(const struct tm& tm);
 };
 
     wxDateTime operator(const struct tm& tm);
 };
 

+/**
+    Global instance of an empty wxDateTime object.
+
+    @todo wouldn't be better to rename it wxNullDateTime as for the rest of wx global objects
+          which are initialized to an empty value?
+*/
+wxDateTime wxDefaultDateTime;
+

 
 
 /**
 
 
 /**

diff --git a/interface/font.h b/interface/font.h
index bcbe16bd900ce085ce4d9927d359df7bc9c8215e..a3eeaba9fecba73fac8de4cbc9b3426b98af0d4e 100644 (file)
--- a/interface/font.h
+++ b/interface/font.h
@@ -29,8 +29,7 @@
     @category{gdi}
 
     @stdobjects
     @category{gdi}
 
     @stdobjects

-    ::Objects:, ::wxNullFont, ::Pointers:, ::wxNORMAL_FONT, ::wxSMALL_FONT,
-    ::wxITALIC_FONT, ::wxSWISS_FONT,
+    ::wxNullFont, ::wxNORMAL_FONT, ::wxSMALL_FONT, ::wxITALIC_FONT, ::wxSWISS_FONT

 
     @see @ref overview_wxfontoverview, wxDC::SetFont, wxDC::DrawText,
     wxDC::GetTextExtent, wxFontDialog, wxSystemSettings
 
     @see @ref overview_wxfontoverview, wxDC::SetFont, wxDC::DrawText,
     wxDC::GetTextExtent, wxFontDialog, wxSystemSettings


@@ -652,7 +651,7 @@ public:
 
 
 /**
 
 
 /**

-    FIXME
+    An empty wxFont.

 */
 wxFont wxNullFont;
 
 */
 wxFont wxNullFont;
 


@@ -677,6 +676,47 @@ wxFont wxITALIC_FONT;
 wxFont wxSWISS_FONT;
 
 
 wxFont wxSWISS_FONT;
 
 

+/**
+    @class wxFontList
+    @wxheader{gdicmn.h}
+
+    A font list is a list containing all fonts which have been created. There
+    is only one instance of this class: @b wxTheFontList.  Use this object to search
+    for a previously created font of the desired type and create it if not already
+    found.
+    In some windowing systems, the font may be a scarce resource, so it is best to
+    reuse old resources if possible.  When an application finishes, all fonts will
+    be
+    deleted and their resources freed, eliminating the possibility of 'memory
+    leaks'.
+
+    @library{wxcore}
+    @category{gdi}
+
+    @see wxFont
+*/
+class wxFontList : public wxList
+{
+public:
+    /**
+        Constructor. The application should not construct its own font list:
+        use the object pointer @b wxTheFontList.
+    */
+    wxFontList();
+
+    /**
+        Finds a font of the given specification, or creates one and adds it to the
+        list. See the @ref wxFont::ctor "wxFont constructor" for
+        details of the arguments.
+    */
+    wxFont* FindOrCreateFont(int point_size, int family, int style,
+                             int weight,
+                             bool underline = false,
+                             const wxString& facename = NULL,
+                             wxFontEncoding encoding = wxFONTENCODING_DEFAULT);
+};
+
+

 
 // ============================================================================
 // Global functions/macros
 
 // ============================================================================
 // Global functions/macros

diff --git a/interface/gdicmn.h b/interface/gdicmn.h
index fb7f166798455ca767623481442218c808eddf5d..724de72b8486b21a450669c4915c66c69f251aac 100644 (file)
--- a/interface/gdicmn.h
+++ b/interface/gdicmn.h
@@ -8,7 +8,9 @@
 
 
 /**
 
 
 /**

-    Bitmap flags.
+    Bitmap type flags.
+
+    See wxBitmap and wxImage classes.

 */
 enum wxBitmapType
 {
 */
 enum wxBitmapType
 {


@@ -50,6 +52,8 @@ enum wxBitmapType
 
 /**
     Standard cursors.
 
 /**
     Standard cursors.

+
+    See wxCursor.

 */
 enum wxStockCursor
 {
 */
 enum wxStockCursor
 {


@@ -98,6 +102,7 @@ enum wxStockCursor
     @wxheader{gdicmn.h}
 
     A @b wxRealPoint is a useful data structure for graphics operations.
     @wxheader{gdicmn.h}
 
     A @b wxRealPoint is a useful data structure for graphics operations.

+

     It contains floating point @e x and @e y members.
     See also wxPoint for an integer version.
 
     It contains floating point @e x and @e y members.
     See also wxPoint for an integer version.
 


@@ -109,16 +114,22 @@ enum wxStockCursor
 class wxRealPoint
 {
 public:
 class wxRealPoint
 {
 public:

-    //@{
+    wxRealPoint();
+

     /**
     /**

-        Create a point.
-        double  x
-        double  y
-        Members of the @b wxRealPoint object.
+        Initializes the point with the given coordinates.

     */
     */

-    wxRealPoint();

     wxRealPoint(double x, double y);
     wxRealPoint(double x, double y);

-    //@}
+
+    /**
+        X coordinate of this point.
+    */
+    double x;
+
+    /**
+        Y coordinate of this point.
+    */
+    double y;

 };
 
 
 };
 
 


@@ -423,6 +434,9 @@ public:
     @library{wxcore}
     @category{data}
 
     @library{wxcore}
     @category{data}
 

+    @stdobjects
+    ::wxDefaultPosition
+

     @see wxRealPoint
 */
 class wxPoint
     @see wxRealPoint
 */
 class wxPoint


@@ -468,6 +482,10 @@ public:
     */
 };
 
     */
 };
 

+/**
+    Global istance of a wxPoint initialized with values -1;-1.
+*/
+wxPoint wxDefaultPosition;

 
 
 /**
 
 
 /**


@@ -524,49 +542,6 @@ public:
 };
 
 
 };
 
 

-
-/**
-    @class wxFontList
-    @wxheader{gdicmn.h}
-
-    A font list is a list containing all fonts which have been created. There
-    is only one instance of this class: @b wxTheFontList.  Use this object to search
-    for a previously created font of the desired type and create it if not already
-    found.
-    In some windowing systems, the font may be a scarce resource, so it is best to
-    reuse old resources if possible.  When an application finishes, all fonts will
-    be
-    deleted and their resources freed, eliminating the possibility of 'memory
-    leaks'.
-
-    @library{wxcore}
-    @category{gdi}
-
-    @see wxFont
-*/
-class wxFontList : public wxList
-{
-public:
-    /**
-        Constructor. The application should not construct its own font list:
-        use the object pointer @b wxTheFontList.
-    */
-    wxFontList();
-
-    /**
-        Finds a font of the given specification, or creates one and adds it to the
-        list. See the @ref wxFont::ctor "wxFont constructor" for
-        details of the arguments.
-    */
-    wxFont* FindOrCreateFont(int point_size, int family, int style,
-                             int weight,
-                             bool underline = false,
-                             const wxString& facename = NULL,
-                             wxFontEncoding encoding = wxFONTENCODING_DEFAULT);
-};
-
-
-

 /**
     @class wxSize
     @wxheader{gdicmn.h}
 /**
     @class wxSize
     @wxheader{gdicmn.h}


@@ -582,10 +557,12 @@ public:
     named @c width and @c height since it makes much more sense for
     sizes.
 
     named @c width and @c height since it makes much more sense for
     sizes.
 

-

     @library{wxcore}
     @category{data}
 
     @library{wxcore}
     @category{data}
 

+    @stdobjects
+    ::wxDefaultSize
+

     @see wxPoint, wxRealPoint
 */
 class wxSize
     @see wxPoint, wxRealPoint
 */
 class wxSize


@@ -715,6 +692,10 @@ public:
     void SetWidth(int width);
 };
 
     void SetWidth(int width);
 };
 

+/**
+    Global instance of a wxSize object initialized with values -1;-1.
+*/
+wxSize wxDefaultSize;

 
 
 
 
 
 

diff --git a/interface/icon.h b/interface/icon.h
index 9b2d4282f21c30daa38cb9b5fa1552550743c988..877215fa522541e77340478f5c1176bf87272206 100644 (file)
--- a/interface/icon.h
+++ b/interface/icon.h
@@ -25,7 +25,7 @@
     @category{gdi}
 
     @stdobjects
     @category{gdi}
 
     @stdobjects

-    ::Objects:, ::wxNullIcon,
+    ::wxNullIcon

 
     @see @ref overview_wxbitmapoverview "Bitmap and icon overview", @ref
     overview_supportedbitmapformats "supported bitmap file formats", wxDC::DrawIcon, wxCursor
 
     @see @ref overview_wxbitmapoverview "Bitmap and icon overview", @ref
     overview_supportedbitmapformats "supported bitmap file formats", wxDC::DrawIcon, wxCursor


@@ -313,15 +313,8 @@ public:
     wxIcon operator =(const wxIcon& icon);
 };
 
     wxIcon operator =(const wxIcon& icon);
 };
 

-
-/**
-    FIXME
-*/
-wxIcon Objects:
-;
-

 /**
 /**

-    FIXME
+    An empty wxIcon.

 */
 wxIcon wxNullIcon;
 
 */
 wxIcon wxNullIcon;
 

diff --git a/interface/iconbndl.h b/interface/iconbndl.h
index 1ac83d47c51658f57faa9c1fb6eb730a522570f4..5fd493b68d087e9b4e818f92a1205339d55a9f84 100644 (file)
--- a/interface/iconbndl.h
+++ b/interface/iconbndl.h
@@ -18,7 +18,7 @@
     @category{FIXME}
 
     @stdobjects
     @category{FIXME}
 
     @stdobjects

-    ::wxNullIconBundle,
+    ::wxNullIconBundle

 */
 class wxIconBundle : public wxGDIObject
 {
 */
 class wxIconBundle : public wxGDIObject
 {


@@ -82,7 +82,7 @@ public:
 
 
 /**
 
 
 /**

-    FIXME
+    An empty wxIconBundle.

 */
 wxIconBundle wxNullIconBundle;
 
 */
 wxIconBundle wxNullIconBundle;
 

diff --git a/interface/image.h b/interface/image.h
index 65cfa7571b643ff4e33b4d63a88507989ce9d507..20c057734e71c30e6fecd7a8d2d2cd394b212d10 100644 (file)
--- a/interface/image.h
+++ b/interface/image.h
@@ -155,12 +155,14 @@ public:
     be drawn in a device context, using wxDC::DrawBitmap.
 
     One colour value of the image may be used as a mask colour which will lead to
     be drawn in a device context, using wxDC::DrawBitmap.
 
     One colour value of the image may be used as a mask colour which will lead to

-    the automatic
-    creation of a wxMask object associated to the bitmap object.
+    the automatic creation of a wxMask object associated to the bitmap object.

 
     @library{wxcore}
     @category{gdi}
 
 
     @library{wxcore}
     @category{gdi}
 

+    @stdobjects
+    ::wxNullImage
+

     @see wxBitmap, wxInitAllImageHandlers()
 */
 class wxImage : public wxObject
     @see wxBitmap, wxInitAllImageHandlers()
 */
 class wxImage : public wxObject


@@ -1461,6 +1463,10 @@ public:
     wxImage operator =(const wxImage& image);
 };
 
     wxImage operator =(const wxImage& image);
 };
 

+/**
+    An empty wxImage.
+*/
+wxImage wxNullImage;

 
 
 // ============================================================================
 
 
 // ============================================================================

diff --git a/interface/palette.h b/interface/palette.h
index 6a5663e1691b2c40894f58bcc6698860b9bf0e9f..28707a3a622ff8d8f7825e253cfa0b1fc0dbea94 100644 (file)
--- a/interface/palette.h
+++ b/interface/palette.h
@@ -39,12 +39,14 @@ public:
         Default constructor.
     */
     wxPalette();
         Default constructor.
     */
     wxPalette();

+

     /**
         Copy constructor, uses @ref overview_refcount.
     */
     wxPalette(const wxPalette& palette);
     /**
         Copy constructor, uses @ref overview_refcount.
     */
     wxPalette(const wxPalette& palette);

+

     /**
     /**

-        Creates a palette from arrays of size @e n, one for each red, blue or
+        Creates a palette from arrays of size @a n, one for each red, blue or

         green component.
 
         @param palette
         green component.
 
         @param palette


@@ -72,7 +74,7 @@ public:
     ~wxPalette();
 
     /**
     ~wxPalette();
 
     /**

-        Creates a palette from arrays of size @e n, one for each red, blue or
+        Creates a palette from arrays of size @a n, one for each red, blue or

         green component.
 
         @param n
         green component.
 
         @param n


@@ -147,7 +149,7 @@ public:
 
 
 /**
 
 
 /**

-    FIXME
+    An empty palette.

 */
 wxPalette wxNullPalette;
 
 */
 wxPalette wxNullPalette;