From 4e43c815181033d3c037dbea51213f9610e3f21a Mon Sep 17 00:00:00 2001
From: Vadim Zeitlin <vadim@wxwidgets.org>
Date: Mon, 13 Feb 2006 15:18:35 +0000
Subject: [PATCH] minor docs corrections and improvements from Andreas Mohr
 (patch 1430551)

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@37557 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
---
 docs/latex/wx/cmdproc.tex  |  2 +-
 docs/latex/wx/filename.tex | 13 +++++++++++--
 docs/latex/wx/http.tex     |  8 ++++----
 docs/latex/wx/listctrl.tex |  2 +-
 docs/latex/wx/listview.tex |  4 ++--
 docs/latex/wx/mdi.tex      |  2 +-
 docs/latex/wx/treectrl.tex |  5 ++---
 docs/latex/wx/ttreectl.tex |  2 +-
 docs/latex/wx/window.tex   |  8 ++++----
 docs/latex/wx/wxstring.tex |  3 ++-
 10 files changed, 29 insertions(+), 20 deletions(-)

diff --git a/docs/latex/wx/cmdproc.tex b/docs/latex/wx/cmdproc.tex
index 515dd43278..329b15e48c 100644
--- a/docs/latex/wx/cmdproc.tex
+++ b/docs/latex/wx/cmdproc.tex
@@ -48,7 +48,7 @@ Returns true if the currently-active command can be undone, false otherwise.
 
 \func{virtual void}{ClearCommands}{\void}
 
-Deletes all the commands in the list and sets the current command pointer to NULL.
+Deletes all commands in the list and sets the current command pointer to \NULL.
 
 
 \membersection{wxCommandProcessor::Redo}\label{wxcommandprocessorredo}
diff --git a/docs/latex/wx/filename.tex b/docs/latex/wx/filename.tex
index 0c0d22dc1e..62420c03fe 100644
--- a/docs/latex/wx/filename.tex
+++ b/docs/latex/wx/filename.tex
@@ -429,7 +429,12 @@ Returns the last time the file was last modified.
 
 \constfunc{wxString}{GetName}{\void}
 
-Returns the name part of the filename.
+Returns the name part of the filename (without extension).
+
+\wxheading{See also}
+
+\helpref{GetFullName}{wxfilenamegetfullname}
+
 
 
 \membersection{wxFileName::GetPath}\label{wxfilenamegetpath}
@@ -802,7 +807,11 @@ The full name is the file name and extension (but without the path).
 
 \func{void}{SetName}{\param{const wxString\& }{name}}
 
-Sets the name.
+Sets the name part (without extension).
+
+\wxheading{See also}
+
+\helpref{SetFullName}{wxfilenamesetfullname}
 
 
 \membersection{wxFileName::SetTimes}\label{wxfilenamesettimes}
diff --git a/docs/latex/wx/http.tex b/docs/latex/wx/http.tex
index e9966fe8ad..613012a809 100644
--- a/docs/latex/wx/http.tex
+++ b/docs/latex/wx/http.tex
@@ -21,8 +21,8 @@
 
 \constfunc{int}{GetResponse}{\void}
 
-Returns the HTTP response code returned by the server. Please refer to the RFC
-2616 for the list of the responses.
+Returns the HTTP response code returned by the server. Please refer to
+\urlref{RFC 2616}{http://www.faqs.org/rfcs/rfc2616.html} for the list of responses.
 
 
 \membersection{wxHTTP::GetInputStream}\label{wxhttpgetinputstream}
@@ -48,7 +48,7 @@ this value will be 0 when the stream is finished.
 Returns the initialized stream. You will have to delete it yourself once you
 don't use it anymore. The destructor closes the network connection.
 The next time you will try to get a file the network connection will have
-to be reestablished: but you don't have to take care of this wxHTTP reestablishes it automatically.
+to be reestablished: but you don't have to take care of this since wxHTTP reestablishes it automatically.
 
 \wxheading{See also}
 
@@ -73,6 +73,6 @@ If the field doesn't exist, it will return an empty string and not a NULL string
 
 \wxheading{Note}
 
-The header is not case-sensitive: I mean that "CONTENT-TYPE" and "content-type" 
+The header is not case-sensitive, i.e. "CONTENT-TYPE" and "content-type" 
 represent the same header.
 
diff --git a/docs/latex/wx/listctrl.tex b/docs/latex/wx/listctrl.tex
index 1bc8a71a79..061e22ebc7 100644
--- a/docs/latex/wx/listctrl.tex
+++ b/docs/latex/wx/listctrl.tex
@@ -204,7 +204,7 @@ Creates the list control. See \helpref{wxListCtrl::wxListCtrl}{wxlistctrlctor} f
 
 \func{bool}{DeleteAllItems}{}
 
-Deletes all the items in the list control.
+Deletes all items in the list control.
 
 {\bf NB:} This function does {\it not} send the
 {\tt wxEVT\_COMMAND\_LIST\_DELETE\_ITEM} event because deleting many items
diff --git a/docs/latex/wx/listview.tex b/docs/latex/wx/listview.tex
index befca96ca9..c5a46dcc11 100644
--- a/docs/latex/wx/listview.tex
+++ b/docs/latex/wx/listview.tex
@@ -19,7 +19,7 @@ future some ports might implement wxListView but not the full set of wxListCtrl
 features.
 
 Other than different interface, this class is identical to wxListCtrl. In
-particular, it uses the same events, same windows styles and so on.
+particular, it uses the same events, same window styles and so on.
 
 \wxheading{Derived from}
 
@@ -68,7 +68,7 @@ used to iterate over all selected items in the control.
 
 \wxheading{Return value}
 
-The fisrt selected item, if any, $-1$ otherwise.
+The first selected item, if any, $-1$ otherwise.
 
 
 \membersection{wxListView::GetFocusedItem}\label{wxlistviewgetfocuseditem}
diff --git a/docs/latex/wx/mdi.tex b/docs/latex/wx/mdi.tex
index f4ed04e303..fc91d4f436 100644
--- a/docs/latex/wx/mdi.tex
+++ b/docs/latex/wx/mdi.tex
@@ -245,7 +245,7 @@ Child frames may be of class \helpref{wxMDIChildFrame}{wxmdichildframe} (contain
 within the parent frame) or \helpref{wxFrame}{wxframe} (shown as a top-level frame).
 
 An MDI parent frame always has a \helpref{wxMDIClientWindow}{wxmdiclientwindow} associated with it, which
-is the parent for MDI client frames.
+is the parent for MDI child frames.
 This client window may be resized to accommodate non-MDI windows, as seen in Microsoft Visual C++ (TM) and
 Microsoft Publisher (TM), where a documentation window is placed to one side of the workspace.
 
diff --git a/docs/latex/wx/treectrl.tex b/docs/latex/wx/treectrl.tex
index a6ba8b7931..c20646f507 100644
--- a/docs/latex/wx/treectrl.tex
+++ b/docs/latex/wx/treectrl.tex
@@ -104,8 +104,7 @@ wxTreeCtrl class uses the standard common treeview control under Win32
 implemented in the system library {\tt comctl32.dll}. Some versions of this
 library are known to have bugs with handling the tree control colours: the
 usual symptom is that the expanded items leave black (or otherwise incorrectly
-coloured) background behind them, especially for the controls using non
-default background colour. The recommended solution is to upgrade the {\tt comctl32.dll}
+coloured) background behind them, especially for the controls using non-default background colour. The recommended solution is to upgrade the {\tt comctl32.dll}
 to a newer version: see 
 \urlref{http://www.microsoft.com/downloads/release.asp?ReleaseID=11916}{http://www.microsoft.com/downloads/release.asp?ReleaseID=11916}.
 
@@ -258,7 +257,7 @@ This function may cause a subsequent call to GetNextChild to fail.
 
 \func{void}{DeleteAllItems}{\void}
 
-Deletes all the items in the control. Note that this may not generate 
+Deletes all items in the control. Note that this may not generate 
 {\tt EVT\_TREE\_DELETE\_ITEM} events under some Windows versions although
 normally such event is generated for each removed item.
 
diff --git a/docs/latex/wx/ttreectl.tex b/docs/latex/wx/ttreectl.tex
index 4298d96a6b..93bc9daf50 100644
--- a/docs/latex/wx/ttreectl.tex
+++ b/docs/latex/wx/ttreectl.tex
@@ -76,6 +76,6 @@ Finally, the tree control has a keyboard interface: the cursor navigation (arrow
 may be used to change the current selection. <HOME> and <END> are used to go to
 the first/last sibling of the current item. '+', '-' and '*' expand, collapse
 and toggle the current branch. Note, however, that <DEL> and <INS> keys do
-nothing by default, but it is usual to associate them with deleting item from
+nothing by default, but it is common to associate them with deleting an item from
 a tree and inserting a new one into it.
 
diff --git a/docs/latex/wx/window.tex b/docs/latex/wx/window.tex
index dadaf4ef1d..a718081c98 100644
--- a/docs/latex/wx/window.tex
+++ b/docs/latex/wx/window.tex
@@ -1498,7 +1498,7 @@ This is just a wrapper for \helpref{ScrollLines}{wxwindowscrolllines}$(-1)$.
 
 \func{void}{Lower}{\void}
 
-Lowers the window to the bottom of the window hierarchy.
+Lowers the window to the bottom of the window hierarchy (z-order).
 
 \wxheading{See also}
 
@@ -2197,9 +2197,9 @@ remove the event handler.
 
 \func{void}{Raise}{\void}
 
-Raises the window to the top of the window hierarchy.
+Raises the window to the top of the window hierarchy (z-order).
 
-In current version of wxWidgets this works both for manage and child windows.
+In current version of wxWidgets this works both for managed and child windows.
 
 \wxheading{See also}
 
@@ -3131,7 +3131,7 @@ value should be used.}
 {\bf wxSIZE\_AUTO\_WIDTH}: a $wxDefaultCoord$ width value is taken to indicate
 a wxWidgets-supplied default width.\\
 {\bf wxSIZE\_AUTO\_HEIGHT}: a $wxDefaultCoord$ height value is taken to indicate
-a wxWidgets-supplied default width.\\
+a wxWidgets-supplied default height.\\
 {\bf wxSIZE\_AUTO}: $wxDefaultCoord$ size values are taken to indicate
 a wxWidgets-supplied default size.\\
 {\bf wxSIZE\_USE\_EXISTING}: existing dimensions should be used
diff --git a/docs/latex/wx/wxstring.tex b/docs/latex/wx/wxstring.tex
index 1d2cb5ea2b..e6f1334c4f 100644
--- a/docs/latex/wx/wxstring.tex
+++ b/docs/latex/wx/wxstring.tex
@@ -1062,7 +1062,8 @@ description of the {\it base} parameter.
 
 \func{wxString\&}{Trim}{\param{bool}{ fromRight = true}}
 
-Removes spaces from the left or from the right (default).
+Removes white-space (space, tabs, form feed, newline and carriage return) from
+the left or from the right end of the string (right is default).
 
 \membersection{wxString::Truncate}\label{wxstringtruncate}
 
-- 
2.45.2

