Fix missing documentation for several GDI functions.

The documentation for wxGetClientDisplayRect(), wxGetDisplayPPI(),
wxGetDisplaySize() and wxGetDisplaySizeMM() didn't appear in the output
because they were documented as "overloads" of the corresponding functions
without "Get" prefix inside an @addtogroup Doxygen macro and apparently this
is not supported.

Simply document them separately to fix this.

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

diff --git a/interface/wx/gdicmn.h b/interface/wx/gdicmn.h
index ec06e76c6f86501502e295b4ef3290827237fc4f..c41ac671f9e96e6e591269d167ea6934b8de8bb8 100644 (file)
--- a/interface/wx/gdicmn.h
+++ b/interface/wx/gdicmn.h
@@ -1154,6 +1154,24 @@ void wxSetCursor(const wxCursor& cursor);
 
 //@}
 
 
 //@}
 

+/** @addtogroup group_funcmacro_gdi */
+//@{
+/**
+    Returns the dimensions of the work area on the display.
+
+    This is the same as wxGetClientDisplayRect() but allows to retrieve the
+    individual components instead of the entire rectangle.
+
+    Any of the output pointers can be @NULL if the corresponding value is not
+    needed by the caller.
+
+    @see wxDisplay
+
+    @header{wx/gdicmn.h}
+*/
+void wxClientDisplayRect(int* x, int* y, int* width, int* height);
+//@}
+

 /** @addtogroup group_funcmacro_gdi */
 //@{
 /**
 /** @addtogroup group_funcmacro_gdi */
 //@{
 /**


@@ -1162,9 +1180,10 @@ void wxSetCursor(const wxCursor& cursor);
     currently defaulting to the whole display until a way is found to provide
     this info for all window managers, etc.
 
     currently defaulting to the whole display until a way is found to provide
     this info for all window managers, etc.
 

+    @see wxDisplay
+

     @header{wx/gdicmn.h}
 */
     @header{wx/gdicmn.h}
 */

-void wxClientDisplayRect(int* x, int* y, int* width, int* height);

 wxRect wxGetClientDisplayRect();
 //@}
 
 wxRect wxGetClientDisplayRect();
 //@}
 


@@ -1178,6 +1197,8 @@ wxRect wxGetClientDisplayRect();
 
     @header{wx/gdicmn.h}
 
 
     @header{wx/gdicmn.h}
 

+    @see wxDisplay
+

     @since 2.9.0
 */
 wxSize wxGetDisplayPPI();
     @since 2.9.0
 */
 wxSize wxGetDisplayPPI();


@@ -1188,12 +1209,25 @@ 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.
+    Either of output pointers can be @NULL if the caller is not interested in
+    the corresponding value.
+
+    @see wxGetDisplaySize(), wxDisplay

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

+//@}
+
+/** @addtogroup group_funcmacro_gdi */
+//@{
+/**
+    Returns the display size in pixels.
+
+    @see wxDisplay
+
+    @header{wx/gdicmn.h}
+*/

 wxSize wxGetDisplaySize();
 //@}
 
 wxSize wxGetDisplaySize();
 //@}
 


@@ -1202,14 +1236,25 @@ 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.
+    Either of output pointers can be @NULL if the caller is not interested in
+    the corresponding value.

 
 

-    @see wxGetDisplayPPI()
+    @see wxGetDisplaySizeMM(), wxDisplay

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

+//@}
+
+/** @addtogroup group_funcmacro_gdi */
+//@{
+/**
+    Returns the display size in millimeters.
+
+    @see wxDisplay
+
+    @header{wx/gdicmn.h}
+*/

 wxSize wxGetDisplaySizeMM();
 //@}
 
 wxSize wxGetDisplaySizeMM();
 //@}