more utils.h fixes

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

diff --git a/interface/utils.h b/interface/utils.h
index ca40c98c0eb462e1203c5021aaeee4c99acd74ad..e6337c5f9efae39da1f41b813ba3f2222b12e1b9 100644 (file)
--- a/interface/utils.h
+++ b/interface/utils.h
@@ -271,25 +271,31 @@ void wxError(const wxString& message,
 */
 wxPowerType wxGetPowerType();
 
-//@{
 /**
-    This function returns the "user id" also known as "login name" under Unix i.e.
-    something like "jsmith". It uniquely identifies the current user (on this
-    system).
-    Under Windows or NT, this function first looks in the environment
-    variables USER and LOGNAME; if neither of these is found, the entry @b UserId
-    in the @b wxWidgets section of the WIN.INI file is tried.
-    The first variant of this function returns the login name if successful or an
-    empty string otherwise. The second (deprecated) function returns @true
-    if successful, @false otherwise.
+    This function returns the "user id" also known as "login name" under Unix
+    i.e.  something like "jsmith". It uniquely identifies the current user (on
+    this system).  Under Windows or NT, this function first looks in the
+    environment variables USER and LOGNAME; if neither of these is found, the
+    entry @b UserId in the @b wxWidgets section of the WIN.INI file is tried.
+
+    @return Returns the login name if successful or an empty string otherwise.
 
     @see wxGetUserName()
 
     @header{wx/utils.h}
 */
 wxString wxGetUserId();
+
+/**
+    @deprecated
+    This form is deprecated, use wxGetUserId() version that returns wxString.
+
+    @param buf Buffer to store login name in.
+    @param sz  Size of the buffer.
+
+    @return Returns @true if successful, @false otherwise.
+ */
 bool wxGetUserId(char* buf, int sz);
-//@}
 
 /**
     Returns battery state as one of @c wxBATTERY_NORMAL_STATE,
@@ -303,20 +309,18 @@ bool wxGetUserId(char* buf, int sz);
 wxBatteryState wxGetBatteryState();
 
 /**
-    @b NB: This function is obsolete, please use
-    wxWindow::FindWindowByName instead.
-    Find a window by its name (as given in a window constructor or @b Create
-    function call).
-    If @a parent is @NULL, the search will start from all top-level
-    frames and dialog boxes; if non-@NULL, the search will be limited to the given
-    window hierarchy.
-    The search is recursive in both cases.
-    If no such named window is found, @b wxFindWindowByLabel is called.
+    @deprecated
+    This function is obsolete, please use wxWindow::FindWindowByName() instead.
+
+    Find a window by its name (as given in a window constructor or Create()
+    function call).  If @a parent is @NULL, the search will start from all
+    top-level frames and dialog boxes; if non-@NULL, the search will be limited
+    to the given window hierarchy.  The search is recursive in both cases.  If
+    no such named window is found, wxFindWindowByLabel() is called.
 
     @header{wx/utils.h}
 */
-wxWindow* wxFindWindowByName(const wxString& name,
-                             wxWindow* parent = NULL);
+wxWindow* wxFindWindowByName(const wxString& name, wxWindow* parent = NULL);
 
 /**
     This function is deprecated as the ids generated by it can conflict with the