mention that width/height parameters to wxDisplaySize[MM]() can be NULL

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

diff --git a/interface/wx/gdicmn.h b/interface/wx/gdicmn.h
index fb9d647fab321829000938a5c3d0214f04ba6c18..8a72f9352dcf1123c48d44a22a31989bf9293dab 100644 (file)
--- a/interface/wx/gdicmn.h
+++ b/interface/wx/gdicmn.h
@@ -857,6 +857,9 @@ wxRect wxGetClientDisplayRect();
 /**
     Returns the display resolution in pixels per inch.
 
 /**
     Returns the display resolution in pixels per inch.
 

+    The @c x component of the returned wxSize object contains the horizontal
+    resolution and the @c y one -- the vertical resolution.
+

     @header{wx/gdicmn.h}
 
     @since 2.9.0
     @header{wx/gdicmn.h}
 
     @since 2.9.0


@@ -869,6 +872,9 @@ wxSize wxGetDisplayPPI();
 /**
     Returns the display size in pixels.
 
 /**
     Returns the display size in pixels.
 

+    For the version taking @a width and @a header arguments, either of them
+    can be @NULL if the caller is not interested in the returned value.
+

     @header{wx/gdicmn.h}
 */
 void wxDisplaySize(int* width, int* height);
     @header{wx/gdicmn.h}
 */
 void wxDisplaySize(int* width, int* height);


@@ -880,6 +886,11 @@ wxSize wxGetDisplaySize();
 /**
     Returns the display size in millimeters.
 
 /**
     Returns the display size in millimeters.
 

+    For the version taking @a width and @a header arguments, either of them
+    can be @NULL if the caller is not interested in the returned value.
+
+    @see wxGetDisplayPPI()
+

     @header{wx/gdicmn.h}
 */
 void wxDisplaySizeMM(int* width, int* height);
     @header{wx/gdicmn.h}
 */
 void wxDisplaySizeMM(int* width, int* height);