more minor doc corrections (patch 1144628)

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

diff --git a/docs/latex/wx/app.tex b/docs/latex/wx/app.tex
index e082aa2f9074bee517fed882ac296922ec33e9b8..1107b980592118bd640aa2dc31e7f5fdf11e6e29 100644 (file)
--- a/docs/latex/wx/app.tex
+++ b/docs/latex/wx/app.tex
@@ -35,14 +35,14 @@ a reference to your application object) to be visible to other files.
 
 \membersection{wxApp::wxApp}\label{wxappctor}
 
-\func{void}{wxApp}{\void}
+\func{}{wxApp}{\void}
 
 Constructor. Called implicitly with a definition of a wxApp object.
 
 
 \membersection{wxApp::\destruct{wxApp}}\label{wxappdtor}
 
-\func{void}{\destruct{wxApp}}{\void}
+\func{}{\destruct{wxApp}}{\void}
 
 Destructor. Will be called implicitly on program exit if the wxApp
 object is created on the stack.

diff --git a/docs/latex/wx/arrstrng.tex b/docs/latex/wx/arrstrng.tex
index e6a7484de20979f6e9170acad012868c93458ac8..6d53707dc542093c2f23067669ffabc7ab3f26de 100644 (file)
--- a/docs/latex/wx/arrstrng.tex
+++ b/docs/latex/wx/arrstrng.tex
@@ -195,7 +195,7 @@ could break the order of items and, for example, subsequent calls to
 
 \membersection{wxArrayString::IsEmpty}\label{wxarraystringisempty}
 
-\func{}{IsEmpty}{}
+\func{bool}{IsEmpty}{}
 
 Returns true if the array is empty, false otherwise. This function returns the
 same result as {\it GetCount() == 0} but is probably easier to read.
@@ -213,7 +213,7 @@ version.
 
 \membersection{wxArrayString::Last}\label{wxarraystringlast}
 
-\func{}{Last}{}
+\func{wxString&}{Last}{}
 
 Returns the last element of the array. Attempt to access the last element of
 an empty array will result in assert failure in debug build, however no checks

diff --git a/docs/latex/wx/brush.tex b/docs/latex/wx/brush.tex
index 2c1c31d47ca1e19ca2e99e628161a6ce39309f72..331aa980faebd895246c0708fa7e01c869eaa19c 100644 (file)
--- a/docs/latex/wx/brush.tex
+++ b/docs/latex/wx/brush.tex
@@ -119,7 +119,7 @@ If a stipple brush is created, the brush style will be set to wxSTIPPLE.
 
 \membersection{wxBrush::\destruct{wxBrush}}\label{wxbrushdtor}
 
-\func{void}{\destruct{wxBrush}}{\void}
+\func{}{\destruct{wxBrush}}{\void}
 
 Destructor.
 

diff --git a/docs/latex/wx/busyinfo.tex b/docs/latex/wx/busyinfo.tex
index b84b0f6c9ac63b40075e5b16bbe889535c2cba13..e9b4ef6a010329a3f488b0ab7723923326be3ad2 100644 (file)
--- a/docs/latex/wx/busyinfo.tex
+++ b/docs/latex/wx/busyinfo.tex
@@ -53,7 +53,7 @@ None
 
 \membersection{wxBusyInfo::wxBusyInfo}\label{wxbusyinfoctor}
 
-\func{}{wxBusyInfo}{\param{const wxString\&}{ msg}, \param{wxParent }{*parent = NULL}}
+\func{}{wxBusyInfo}{\param{const wxString\&}{ msg}, \param{wxWindow* }{parent = NULL}}
 
 Constructs a busy info window as child of {\it parent} and displays {\it msg}
 in it.

diff --git a/docs/latex/wx/calctrl.tex b/docs/latex/wx/calctrl.tex
index 31141b041d713d0be6b34672da48ff534ee793a3..d5b586b05597b6801b897288abb7d04de261a4b9 100644 (file)
--- a/docs/latex/wx/calctrl.tex
+++ b/docs/latex/wx/calctrl.tex
@@ -113,9 +113,6 @@ enum wxCalendarHitTestResult
 
 Default constructor, use \helpref{Create}{wxcalendarctrlcreate} after it.
 
-
-\membersection{wxCalendarCtrl::wxCalendarCtrl}\label{wxcalendarctrlwxcalendarctrl}
-
 \func{}{wxCalendarCtrl}{\param{wxWindow* }{parent}, \param{wxWindowID }{id}, \param{const wxDateTime\& }{date = wxDefaultDateTime}, \param{const wxPoint\& }{pos = wxDefaultPosition}, \param{const wxSize\& }{size = wxDefaultSize}, \param{long }{style = wxCAL\_SHOW\_HOLIDAYS}, \param{const wxString\& }{name = wxCalendarNameStr}}
 
 Does the same as \helpref{Create}{wxcalendarctrlcreate} method.
@@ -333,6 +330,10 @@ enum wxCalendarDateBorder
 
 \helpref{wxCalendarCtrl}{wxcalendarctrl}
 
+\wxheading{Include files}
+
+<wx/calctrl.h>
+
 \latexignore{\rtfignore{\wxheading{Members}}}
 
 

diff --git a/docs/latex/wx/clientdat.tex b/docs/latex/wx/clientdat.tex
index c4e37c629fddadd122dc6bf5b535eef7e4f2f661..52784d240dd845d01af97feb64d9ab5f4752067c 100644 (file)
--- a/docs/latex/wx/clientdat.tex
+++ b/docs/latex/wx/clientdat.tex
@@ -70,7 +70,7 @@ No base class
 
 \wxheading{Include files}
 
-<clntdata.h>
+<wx/clntdata.h>
 
 \wxheading{Data structures}
 

diff --git a/docs/latex/wx/dataform.tex b/docs/latex/wx/dataform.tex
index a8df372afedfd5db3c1d9e58db064cfe4b408170..ec1cbef38e63f2580465044cecd25ad937f75858 100644 (file)
--- a/docs/latex/wx/dataform.tex
+++ b/docs/latex/wx/dataform.tex
@@ -62,6 +62,10 @@ None
 \helpref{DnD sample}{samplednd}, 
 \helpref{wxDataObject}{wxdataobject}
 
+\wxheading{Include files}
+
+<wx/dataobj.h>
+
 \latexignore{\rtfignore{\wxheading{Members}}}
 
 \membersection{wxDataFormat::wxDataFormat}\label{wxdataformatwxdataformatdef}

diff --git a/docs/latex/wx/datostrm.tex b/docs/latex/wx/datostrm.tex
index cf8bbbe613219f696111fe020e5bee0c36615902..3045a75eca0abfe8efca6c21080a7f7f322d3860 100644 (file)
--- a/docs/latex/wx/datostrm.tex
+++ b/docs/latex/wx/datostrm.tex
@@ -17,6 +17,10 @@ See also \helpref{wxDataInputStream}{wxdatainputstream}.
 
 None
 
+\wxheading{Include files}
+
+<wx/datstrm.h>
+
 \latexignore{\rtfignore{\wxheading{Members}}}
 
 \membersection{wxDataOutputStream::wxDataOutputStream}\label{wxdataoutputstreamctor}

diff --git a/docs/latex/wx/db.tex b/docs/latex/wx/db.tex
index 10cf334c825b7e077813daaaf13ead73e201043e..1158657f99eff7aac2b384f4de461ee81f13379c 100644 (file)
--- a/docs/latex/wx/db.tex
+++ b/docs/latex/wx/db.tex
@@ -1605,6 +1605,12 @@ public.
 \helpref{database classes overview}{odbcoverview},
 \helpref{wxDbTable::GetColDefs}{wxdbtablegetcoldefs}, \helpref{wxDb constructor}{wxdbctor}
 
+\wxheading{Include files}
+
+<wx/db.h>
+
+\latexignore{\rtfignore{\wxheading{Members}}}
+
 \membersection{wxDbColDef::Initialize}\label{wxdbcoldefinitialize}
 
 Simply initializes all member variables to a cleared state.  Called by
@@ -1643,6 +1649,12 @@ Only one function is provided with this class currently.
 See the \helpref{database classes overview}{odbcoverview} for
 an introduction to using the ODBC classes.
 
+\wxheading{Include files}
+
+<wx/db.h>
+
+\latexignore{\rtfignore{\wxheading{Members}}}
+
 \membersection{wxDbColFor::Format}\label{wxdbcolforformat}
 
 \func{int }{Format}{\param{int }{Nation}, \param{int }{dbDataType},
@@ -1699,6 +1711,12 @@ it is non-NULL.
 See the \helpref{database classes overview}{odbcoverview} for
 an introduction to using the ODBC classes.
 
+\wxheading{Include files}
+
+<wx/db.h>
+
+\latexignore{\rtfignore{\wxheading{Members}}}
+
 \membersection{wxDbColInf::Initialize}\label{wxdbcolinfinitialize}
 
 Simply initializes all member variables to a cleared state.  Called by
@@ -2010,6 +2028,12 @@ it is non-NULL.
 See the \helpref{database classes overview}{odbcoverview} for
 an introduction to using the ODBC classes.
 
+\wxheading{Include files}
+
+<wx/db.h>
+
+\latexignore{\rtfignore{\wxheading{Members}}}
+
 \membersection{wxDbInf::Initialize}\label{wxdbinfinitialize}
 
 Simply initializes all member variables to a cleared state.  Called by
@@ -3973,6 +3997,12 @@ Eventually, accessor functions will be added for this class
 See the \helpref{database classes overview}{odbcoverview} for
 an introduction to using the ODBC classes.
 
+\wxheading{Include files}
+
+<wx/db.h>
+
+\latexignore{\rtfignore{\wxheading{Members}}}
+
 \membersection{wxDbTableInf::Initialize}\label{wxdbtableinfinitialize}
 
 Simply initializes all member variables to a cleared state.  Called by

diff --git a/docs/latex/wx/dialup.tex b/docs/latex/wx/dialup.tex
index 3ad68900668e69aa70df94bcf0b841d15ac6fd9a..41ca690b6a0eb81fe9b0eb6045af5cc27888d8df 100644 (file)
--- a/docs/latex/wx/dialup.tex
+++ b/docs/latex/wx/dialup.tex
@@ -203,7 +203,7 @@ is always safe to call. The default value is {\tt www.yahoo.com:80}.
 
 \membersection{wxDialUpManager::SetConnectCommand}\label{wxdialupmanagersetconnectcommand}
 
-\func{}{SetConnectCommand}{\param{const wxString\& }{commandDial = wxT("/usr/bin/pon")}, \param{const wxString\& }{commandHangup = wxT("/usr/bin/poff")}}
+\func{void}{SetConnectCommand}{\param{const wxString\& }{commandDial = wxT("/usr/bin/pon")}, \param{const wxString\& }{commandHangup = wxT("/usr/bin/poff")}}
 
 This method is for Unix only.
 

diff --git a/docs/latex/wx/docmanag.tex b/docs/latex/wx/docmanag.tex
index a7669884ce6426e39e81bf21a9d3a6c61cb26922..5921f1df828729c98f5f901e5859bdc1f7ef1a7a 100644 (file)
--- a/docs/latex/wx/docmanag.tex
+++ b/docs/latex/wx/docmanag.tex
@@ -72,7 +72,7 @@ A list of all document templates.
 
 \membersection{wxDocManager::wxDocManager}\label{wxdocmanagerctor}
 
-\func{void}{wxDocManager}{\param{long}{ flags = wxDEFAULT\_DOCMAN\_FLAGS}, \param{bool}{ initialize = true}}
+\func{}{wxDocManager}{\param{long}{ flags = wxDEFAULT\_DOCMAN\_FLAGS}, \param{bool}{ initialize = true}}
 
 Constructor. Create a document manager instance dynamically near the start of your application
 before doing any document or view operations.

diff --git a/docs/latex/wx/flexsizr.tex b/docs/latex/wx/flexsizr.tex
index be71c5c326e08f197fd9c30e7796153d1c0b91a3..f19c7640cf353d0613b53d50b3044a058ad8cac8 100644 (file)
--- a/docs/latex/wx/flexsizr.tex
+++ b/docs/latex/wx/flexsizr.tex
@@ -29,6 +29,7 @@ serves this purpose.
 
 \helpref{wxSizer}{wxsizer}, \helpref{Sizer overview}{sizeroverview}
 
+\latexignore{\rtfignore{\wxheading{Members}}}
 
 \membersection{wxFlexGridSizer::wxFlexGridSizer}\label{wxflexgridsizerwxflexgridsizer}
 

diff --git a/docs/latex/wx/gridattr.tex b/docs/latex/wx/gridattr.tex
index 0cb367494ce3f7f6ebce60454c87d7f8914ec857..bb3dfe217caa71e450b1d5720948a2820ddc55fc 100644 (file)
--- a/docs/latex/wx/gridattr.tex
+++ b/docs/latex/wx/gridattr.tex
@@ -13,7 +13,9 @@ class may be returned by wxGridTable::GetAttr().
 
 No base class
 
-\wxheading{Data structures}
+\wxheading{Include files}
+
+<wx/grid.h>
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 

diff --git a/docs/latex/wx/gridedit.tex b/docs/latex/wx/gridedit.tex
index 87440ff226fd6fc163d319722447fecb66e6bed1..1aa6b7a9c8b15a05d55d770d8460f0ca545cf703 100644 (file)
--- a/docs/latex/wx/gridedit.tex
+++ b/docs/latex/wx/gridedit.tex
@@ -19,6 +19,10 @@ The editor for boolean data.
 \helpref{wxGridCellTextEditor}{wxgridcelltexteditor},\rtfsp
 \helpref{wxGridCellChoiceEditor}{wxgridcellchoiceeditor}
 
+\wxheading{Include files}
+
+<wx/grid.h>
+
 \latexignore{\rtfignore{\wxheading{Members}}}
 
 
@@ -86,6 +90,10 @@ wxGridCellWorker
 \helpref{wxGridCellNumberEditor}{wxgridcellnumbereditor},\rtfsp
 \helpref{wxGridCellChoiceEditor}{wxgridcellchoiceeditor}
 
+\wxheading{Include files}
+
+<wx/grid.h>
+
 \latexignore{\rtfignore{\wxheading{Members}}}
 
 \membersection{wxGridCellEditor::wxGridCellEditor}\label{wxgridcelleditorwxgridcelleditor}
@@ -200,9 +208,11 @@ The editor for floating point numbers data.
 \helpref{wxGridCellTextEditor}{wxgridcelltexteditor},\rtfsp
 \helpref{wxGridCellChoiceEditor}{wxgridcellchoiceeditor}
 
+\wxheading{Include files}
 
-\latexignore{\rtfignore{\wxheading{Members}}}
+<wx/grid.h>
 
+\latexignore{\rtfignore{\wxheading{Members}}}
 
 \membersection{wxGridCellFloatEditor::wxGridCellFloatEditor}\label{wxgridcellfloateditorconstr}
 
@@ -237,9 +247,11 @@ The editor for numeric integer data.
 \helpref{wxGridCellTextEditor}{wxgridcelltexteditor},\rtfsp
 \helpref{wxGridCellChoiceEditor}{wxgridcellchoiceeditor}
 
+\wxheading{Include files}
 
-\latexignore{\rtfignore{\wxheading{Members}}}
+<wx/grid.h>
 
+\latexignore{\rtfignore{\wxheading{Members}}}
 
 \membersection{wxGridCellNumberEditor::wxGridCellNumberEditor}\label{wxgridcellnumbereditorconstr}
 
@@ -287,6 +299,10 @@ The editor for string/text data.
 \helpref{wxGridCellNumberEditor}{wxgridcellnumbereditor},\rtfsp
 \helpref{wxGridCellChoiceEditor}{wxgridcellchoiceeditor}
 
+\wxheading{Include files}
+
+<wx/grid.h>
+
 \latexignore{\rtfignore{\wxheading{Members}}}
 
 

diff --git a/docs/latex/wx/gridevt.tex b/docs/latex/wx/gridevt.tex
index 0215e809774d01fb2b065a6b8ebd6d603b0dd6b6..3ef3b80d295abff7988df746daf8ad029254d3cb 100644 (file)
--- a/docs/latex/wx/gridevt.tex
+++ b/docs/latex/wx/gridevt.tex
@@ -18,6 +18,10 @@ The ...\_CMD\_... variants also take a window identifier.
 \twocolitem{{\bf EVT\_GRID\_CMD\_EDITOR\_CREATED(id, func)}}{The editor for a cell was created; variant taking a window identifier. Processes a wxEVT\_GRID\_EDITOR\_CREATED.}
 \end{twocollist}%
 
+\wxheading{Include files}
+
+<wx/grid.h>
+
 \latexignore{\rtfignore{\wxheading{Members}}}
 
 \membersection{wxGridEditorCreatedEvent::wxGridEditorCreatedEvent}\label{wxgrideditorcreatedeventconstr}
@@ -169,6 +173,10 @@ The ...\_CMD\_... variants also take a window identifier.
 \twocolitem{{\bf EVT\_GRID\_CMD\_RANGE\_SELECT(func)}}{The user selected a group of contiguous cells; variant taking a window identifier. Processes a wxEVT\_GRID\_RANGE\_SELECT.}
 \end{twocollist}%
 
+\wxheading{Include files}
+
+<wx/grid.h>
+
 \latexignore{\rtfignore{\wxheading{Members}}}
 
 \membersection{wxGridRangeSelectEvent::wxGridRangeSelectEvent}\label{wxgridrangeselecteventconstr}

diff --git a/docs/latex/wx/gridrend.tex b/docs/latex/wx/gridrend.tex
index 02cfea20eb0c49d85a22b1417ee5abc420eb1723..0bc5ac4dc48337465f54292f2f63c82f9502bb2a 100644 (file)
--- a/docs/latex/wx/gridrend.tex
+++ b/docs/latex/wx/gridrend.tex
@@ -14,6 +14,10 @@ for string cells.
 \helpref{wxGridCellFloatRenderer}{wxgridcellfloatrenderer},\rtfsp
 \helpref{wxGridCellNumberRenderer}{wxgridcellnumberrenderer}
 
+\wxheading{Include files}
+
+<wx/grid.h>
+
 \latexignore{\rtfignore{\wxheading{Members}}}
 
 \membersection{wxGridCellBoolRenderer::wxGridCellBoolRenderer}\label{wxgridcellboolrendererconstr}
@@ -40,6 +44,10 @@ This class may be used to format floating point data in a cell.
 \helpref{wxGridCellStringRenderer}{wxgridcellstringrenderer},\rtfsp
 \helpref{wxGridCellBoolRenderer}{wxgridcellboolrenderer}
 
+\wxheading{Include files}
+
+<wx/grid.h>
+
 \latexignore{\rtfignore{\wxheading{Members}}}
 
 \membersection{wxGridCellFloatRenderer::wxGridCellFloatRenderer}\label{wxgridcellfloatrendererconstr}
@@ -97,6 +105,10 @@ This class may be used to format integer data in a cell.
 \helpref{wxGridCellFloatRenderer}{wxgridcellfloatrenderer},\rtfsp
 \helpref{wxGridCellBoolRenderer}{wxgridcellboolrenderer}
 
+\wxheading{Include files}
+
+<wx/grid.h>
+
 \latexignore{\rtfignore{\wxheading{Members}}}
 
 \membersection{wxGridCellNumberRenderer::wxGridCellNumberRenderer}\label{wxgridcellnumberrendererconstr}
@@ -124,6 +136,10 @@ wxGridCellWorker
 \helpref{wxGridCellFloatRenderer}{wxgridcellfloatrenderer},\rtfsp
 \helpref{wxGridCellBoolRenderer}{wxgridcellboolrenderer}
 
+\wxheading{Include files}
+
+<wx/grid.h>
+
 \latexignore{\rtfignore{\wxheading{Members}}}
 
 \membersection{wxGridCellRenderer::Draw}\label{wxgridcellrendererdraw}
@@ -164,6 +180,10 @@ for string cells.
 \helpref{wxGridCellFloatRenderer}{wxgridcellfloatrenderer},\rtfsp
 \helpref{wxGridCellBoolRenderer}{wxgridcellboolrenderer}
 
+\wxheading{Include files}
+
+<wx/grid.h>
+
 \latexignore{\rtfignore{\wxheading{Members}}}
 
 \membersection{wxGridCellStringRenderer::wxGridCellStringRenderer}\label{wxgridcellstringrendererconstr}

diff --git a/docs/latex/wx/gridtbl.tex b/docs/latex/wx/gridtbl.tex
index d8cc4d26bb9cd808ee4304de88f53e0540438037..b2f361a8f7316db18dc063a48c5a37e788aaca47 100644 (file)
--- a/docs/latex/wx/gridtbl.tex
+++ b/docs/latex/wx/gridtbl.tex
@@ -6,7 +6,9 @@ Grid table classes.
 
 \helpref{wxObject}{wxobject}
 
-\wxheading{Data structures}
+\wxheading{Include files}
+
+<wx/grid.h>
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 

diff --git a/docs/latex/wx/postscpt.tex b/docs/latex/wx/postscpt.tex
index 9e5d4129a440627ab74ceaa3ca7da6db28c425a0..4bdb15f767acdffa1ec8b296f4cb8aec306dd052 100644 (file)
--- a/docs/latex/wx/postscpt.tex
+++ b/docs/latex/wx/postscpt.tex
@@ -13,6 +13,8 @@ descriptions of the member functions.
 
 <wx/dcps.h>
 
+\latexignore{\rtfignore{\wxheading{Members}}}
+
 \membersection{wxPostScriptDC::wxPostScriptDC}\label{wxpostscriptdcctor}
 
 \func{}{wxPostScriptDC}{\param{const wxPrintData\&}{ printData}}

diff --git a/docs/latex/wx/regex.tex b/docs/latex/wx/regex.tex
index c2ee1eab52a1b176c379d6dd739ebab237942ca9..0a6f55075a58bccb5dff346c58c2b87824558650 100644 (file)
--- a/docs/latex/wx/regex.tex
+++ b/docs/latex/wx/regex.tex
@@ -114,6 +114,10 @@ size_t count = reEmail.ReplaceAll(text, wxT("HIDDEN@\\2\\3"));
 printf("text now contains %u hidden addresses", count);
 \end{verbatim}
 
+\wxheading{Include files}
+
+<wx/regex.h>
+
 \latexignore{\rtfignore{\wxheading{Members}}}
 
 \membersection{wxRegEx::wxRegEx}\label{wxregexwxregex}

diff --git a/docs/latex/wx/tooltip.tex b/docs/latex/wx/tooltip.tex
index 14ee782ad5712acab7297c5c65cc29b12d88132e..9347d935d319db1eaf330e99fe79c765fc829f19 100644 (file)
--- a/docs/latex/wx/tooltip.tex
+++ b/docs/latex/wx/tooltip.tex
@@ -1,8 +1,3 @@
-%
-% automatically generated by HelpGen from
-% /home/vasek/tooltip.h at 24/May/00 16:57:08
-%
-
 \section{\class{wxToolTip}}\label{wxtooltip}
 
 This class holds information about a tooltip associated with a window
@@ -16,6 +11,9 @@ alter tooltips behaviour.
 
 \helpref{wxObject}{wxobject}
 
+\wxheading{Include files}
+
+<wx/tooltip.h>
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 

diff --git a/docs/latex/wx/txtstrm.tex b/docs/latex/wx/txtstrm.tex
index 55d5dfe217737f4186cad139a4ec19488c0b0707..70afd2cca0df5b06c03892b63327ca2813a8def1 100644 (file)
--- a/docs/latex/wx/txtstrm.tex
+++ b/docs/latex/wx/txtstrm.tex
@@ -207,6 +207,10 @@ You can also simulate the C++ cout class:
 The wxTextOutputStream writes text files (or streams) on DOS, Macintosh
 and Unix in their native formats (concerning the line ending).
 
+\wxheading{Include files}
+
+<wx/txtstrm.h>
+
 \latexignore{\rtfignore{\wxheading{Members}}}