From 0e10e38d8b4405625c3687bdfe6cb315874d1d70 Mon Sep 17 00:00:00 2001 From: Vadim Zeitlin Date: Sun, 20 Feb 2005 17:06:25 +0000 Subject: [PATCH] more minor doc corrections (patch 1144628) git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@32259 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775 --- docs/latex/wx/app.tex | 4 ++-- docs/latex/wx/arrstrng.tex | 4 ++-- docs/latex/wx/brush.tex | 2 +- docs/latex/wx/busyinfo.tex | 2 +- docs/latex/wx/calctrl.tex | 7 ++++--- docs/latex/wx/clientdat.tex | 2 +- docs/latex/wx/dataform.tex | 4 ++++ docs/latex/wx/datostrm.tex | 4 ++++ docs/latex/wx/db.tex | 30 ++++++++++++++++++++++++++++++ docs/latex/wx/dialup.tex | 2 +- docs/latex/wx/docmanag.tex | 2 +- docs/latex/wx/flexsizr.tex | 1 + docs/latex/wx/gridattr.tex | 4 +++- docs/latex/wx/gridedit.tex | 20 ++++++++++++++++++-- docs/latex/wx/gridevt.tex | 8 ++++++++ docs/latex/wx/gridrend.tex | 20 ++++++++++++++++++++ docs/latex/wx/gridtbl.tex | 4 +++- docs/latex/wx/postscpt.tex | 2 ++ docs/latex/wx/regex.tex | 4 ++++ docs/latex/wx/tooltip.tex | 8 +++----- docs/latex/wx/txtstrm.tex | 4 ++++ 21 files changed, 117 insertions(+), 21 deletions(-) diff --git a/docs/latex/wx/app.tex b/docs/latex/wx/app.tex index e082aa2f90..1107b98059 100644 --- 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 e6a7484de2..6d53707dc5 100644 --- 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 2c1c31d47c..331aa980fa 100644 --- 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 b84b0f6c9a..e9b4ef6a01 100644 --- 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 31141b041d..d5b586b055 100644 --- 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} + + + \latexignore{\rtfignore{\wxheading{Members}}} diff --git a/docs/latex/wx/clientdat.tex b/docs/latex/wx/clientdat.tex index c4e37c629f..52784d240d 100644 --- a/docs/latex/wx/clientdat.tex +++ b/docs/latex/wx/clientdat.tex @@ -70,7 +70,7 @@ No base class \wxheading{Include files} - + \wxheading{Data structures} diff --git a/docs/latex/wx/dataform.tex b/docs/latex/wx/dataform.tex index a8df372afe..ec1cbef38e 100644 --- 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} + + + \latexignore{\rtfignore{\wxheading{Members}}} \membersection{wxDataFormat::wxDataFormat}\label{wxdataformatwxdataformatdef} diff --git a/docs/latex/wx/datostrm.tex b/docs/latex/wx/datostrm.tex index cf8bbbe613..3045a75eca 100644 --- 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} + + + \latexignore{\rtfignore{\wxheading{Members}}} \membersection{wxDataOutputStream::wxDataOutputStream}\label{wxdataoutputstreamctor} diff --git a/docs/latex/wx/db.tex b/docs/latex/wx/db.tex index 10cf334c82..1158657f99 100644 --- 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} + + + +\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} + + + +\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} + + + +\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} + + + +\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} + + + +\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 3ad6890066..41ca690b6a 100644 --- 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 a7669884ce..5921f1df82 100644 --- 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 be71c5c326..f19c7640cf 100644 --- 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 0cb367494c..bb3dfe217c 100644 --- 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} + + \latexignore{\rtfignore{\wxheading{Members}}} diff --git a/docs/latex/wx/gridedit.tex b/docs/latex/wx/gridedit.tex index 87440ff226..1aa6b7a9c8 100644 --- 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} + + + \latexignore{\rtfignore{\wxheading{Members}}} @@ -86,6 +90,10 @@ wxGridCellWorker \helpref{wxGridCellNumberEditor}{wxgridcellnumbereditor},\rtfsp \helpref{wxGridCellChoiceEditor}{wxgridcellchoiceeditor} +\wxheading{Include files} + + + \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}}} + +\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}}} + +\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} + + + \latexignore{\rtfignore{\wxheading{Members}}} diff --git a/docs/latex/wx/gridevt.tex b/docs/latex/wx/gridevt.tex index 0215e80977..3ef3b80d29 100644 --- 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} + + + \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} + + + \latexignore{\rtfignore{\wxheading{Members}}} \membersection{wxGridRangeSelectEvent::wxGridRangeSelectEvent}\label{wxgridrangeselecteventconstr} diff --git a/docs/latex/wx/gridrend.tex b/docs/latex/wx/gridrend.tex index 02cfea20eb..0bc5ac4dc4 100644 --- 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} + + + \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} + + + \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} + + + \latexignore{\rtfignore{\wxheading{Members}}} \membersection{wxGridCellNumberRenderer::wxGridCellNumberRenderer}\label{wxgridcellnumberrendererconstr} @@ -124,6 +136,10 @@ wxGridCellWorker \helpref{wxGridCellFloatRenderer}{wxgridcellfloatrenderer},\rtfsp \helpref{wxGridCellBoolRenderer}{wxgridcellboolrenderer} +\wxheading{Include files} + + + \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} + + + \latexignore{\rtfignore{\wxheading{Members}}} \membersection{wxGridCellStringRenderer::wxGridCellStringRenderer}\label{wxgridcellstringrendererconstr} diff --git a/docs/latex/wx/gridtbl.tex b/docs/latex/wx/gridtbl.tex index d8cc4d26bb..b2f361a8f7 100644 --- 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} + + \latexignore{\rtfignore{\wxheading{Members}}} diff --git a/docs/latex/wx/postscpt.tex b/docs/latex/wx/postscpt.tex index 9e5d4129a4..4bdb15f767 100644 --- a/docs/latex/wx/postscpt.tex +++ b/docs/latex/wx/postscpt.tex @@ -13,6 +13,8 @@ descriptions of the member functions. +\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 c2ee1eab52..0a6f55075a 100644 --- 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} + + + \latexignore{\rtfignore{\wxheading{Members}}} \membersection{wxRegEx::wxRegEx}\label{wxregexwxregex} diff --git a/docs/latex/wx/tooltip.tex b/docs/latex/wx/tooltip.tex index 14ee782ad5..9347d935d3 100644 --- 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} + + \latexignore{\rtfignore{\wxheading{Members}}} diff --git a/docs/latex/wx/txtstrm.tex b/docs/latex/wx/txtstrm.tex index 55d5dfe217..70afd2cca0 100644 --- 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} + + + \latexignore{\rtfignore{\wxheading{Members}}} -- 2.45.2