X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/ae3c17b4013e80b99976c750c19fca47729517f6..5953e7c7d67c212f3513de0d660888c5668441ea:/interface/wx/app.h

diff --git a/interface/wx/app.h b/interface/wx/app.h
index cf79e46a12..3a5e6a0858 100644
--- a/interface/wx/app.h
+++ b/interface/wx/app.h
@@ -9,7 +9,6 @@
 
 /**
     @class wxAppConsole
-    @wxheader{app.h}
 
     This class is essential for writing console-only or hybrid apps without
     having to define wxUSE_GUI=0.
@@ -77,11 +76,12 @@ public:
     /**
         Returns the user-readable application name.
 
-        The difference between this string and the one returned by GetAppName() is that
-        this one is meant to be shown to the user and so should be used for the window
-        titles, page headers and so on while the other one should be only used internally,
-        e.g. for the file names or configuration file keys.
-        By default, returns the same string as GetAppName().
+        The difference between this string and the one returned by GetAppName()
+        is that this one is meant to be shown to the user and so should be used
+        for the window titles, page headers and so on while the other one
+        should be only used internally, e.g. for the file names or
+        configuration file keys. By default, returns the application name as
+        returned by GetAppName() capitalized using wxString::Capitalize().
 
         @since 2.9.0
     */
@@ -107,7 +107,7 @@ public:
 
     /**
         Returns the one and only global application object.
-        Usually ::wxTheApp is usead instead.
+        Usually wxTheApp is used instead.
 
         @see SetInstance()
     */
@@ -371,9 +371,14 @@ public:
     virtual bool Pending();
 
     /**
-        Set the application name to be used in the user-visible places such as window
-        titles. See GetAppDisplayName() for more about the differences between the
+        Set the application name to be used in the user-visible places such as
+        window titles.
+
+        See GetAppDisplayName() for more about the differences between the
         display name and name.
+
+        Notice that if this function is called, the name is used as is, without
+        any capitalization as done by default by GetAppDisplayName().
     */
     void SetAppDisplayName(const wxString& name);
 
@@ -472,7 +477,6 @@ public:
 
 /**
     @class wxApp
-    @wxheader{app.h}
 
     The wxApp class represents the application itself. It is used to:
 
@@ -527,9 +531,10 @@ public:
     /**
         Returns a pointer to the top window.
 
-        @remarks If the top window hasn't been set using SetTopWindow(),
-                 this function will find the first top-level window
-                 (frame or dialog) and return that.
+        @remarks
+            If the top window hasn't been set using SetTopWindow(), this function
+            will find the first top-level window (frame or dialog or instance of
+            wxTopLevelWindow) from the internal top level window list and return that.
 
         @see SetTopWindow()
     */
@@ -620,9 +625,13 @@ public:
         Sets the 'top' window. You can call this from within OnInit() to let wxWidgets
         know which is the main window. You don't have to set the top window;
         it is only a convenience so that (for example) certain dialogs without parents
-        can use a specific window as the top window. If no top window is specified by the
-        application, wxWidgets just uses the first frame or dialog in its top-level window
-        list, when it needs to use the top window.
+        can use a specific window as the top window.
+
+        If no top window is specified by the application, wxWidgets just uses the
+        first frame or dialog (or better, any wxTopLevelWindow) in its top-level
+        window list, when it needs to use the top window.
+        If you previously called SetTopWindow() and now you need to restore this
+        automatic behaviour you can call @code wxApp::SetTopWindow(NULL) @endcode.
 
         @param window
             The new top window.
@@ -791,9 +800,9 @@ void wxWakeUpIdle();
 bool wxYield();
 
 /**
-    This function is similar to wxYield, except that it disables the user input to
-    all program windows before calling wxYield and re-enables it again
-    afterwards. If @a win is not @NULL, this window will remain enabled,
+    This function is similar to wxYield(), except that it disables the user
+    input to all program windows before calling wxYield() and re-enables it
+    again afterwards. If @a win is not @NULL, this window will remain enabled,
     allowing the implementation of some limited user interaction.
     Returns the result of the call to ::wxYield.