From: Vadim Zeitlin <vadim@wxwidgets.org>
Date: Mon, 22 Sep 2008 16:06:56 +0000 (+0000)
Subject: mention that width/height parameters to wxDisplaySize[MM]() can be NULL
X-Git-Url: https://git.saurik.com/wxWidgets.git/commitdiff_plain/ed9dd914653110949b5e061c3283c5554f2a7518

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 fb9d647fab..8a72f9352d 100644
--- a/interface/wx/gdicmn.h
+++ b/interface/wx/gdicmn.h
@@ -857,6 +857,9 @@ wxRect wxGetClientDisplayRect();
 /**
     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
@@ -869,6 +872,9 @@ wxSize wxGetDisplayPPI();
 /**
     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);
@@ -880,6 +886,11 @@ wxSize wxGetDisplaySize();
 /**
     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);