Doc corrections

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/branches/WX_2_8_BRANCH@48887 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Julian Smart
2007-09-21 17:53:07 +00:00
parent 3c93f27b0b
commit 52ce637645
12 changed files with 17 additions and 57 deletions

View File

@@ -54,7 +54,7 @@ is called. If this style flag is given, the control will not change its size}
\latexignore{\rtfignore{\wxheading{Members}}}
\membersection{wxAnimationCtrl::wxAnimationCtrl}\label{wxanimationctrl}
\membersection{wxAnimationCtrl::wxAnimationCtrl}\label{wxanimationctrlctor}
\func{}{wxAnimationCtrl}{\param{wxWindow *}{parent},\rtfsp
\param{wxWindowID}{ id},\rtfsp

View File

@@ -232,21 +232,6 @@ A reference to the selected state bitmap.
\helpref{wxBitmapButton::SetBitmapSelected}{wxbitmapbuttonsetbitmapselected}
\membersection{wxBitmapButton::GetBitmapSelected}\label{wxbitmapbuttongetbitmapselected}
\constfunc{wxBitmap\&}{GetBitmapSelected}{\void}
Returns the bitmap for the selected state.
\wxheading{Return value}
A reference to the selected state bitmap.
\wxheading{See also}
\helpref{wxBitmapButton::SetBitmapSelected}{wxbitmapbuttonsetbitmapselected}
\membersection{wxBitmapButton::SetBitmapDisabled}\label{wxbitmapbuttonsetbitmapdisabled}
\func{void}{SetBitmapDisabled}{\param{const wxBitmap\& }{bitmap}}
@@ -333,20 +318,3 @@ Sets the bitmap for the selected (depressed) button appearance.
\helpref{wxBitmapButton::SetBitmapDisabled}{wxbitmapbuttonsetbitmapdisabled}
\membersection{wxBitmapButton::SetBitmapSelected}\label{wxbitmapbuttonsetbitmapselected}
\func{void}{SetBitmapSelected}{\param{const wxBitmap\& }{bitmap}}
Sets the bitmap for the selected (depressed) button appearance.
\wxheading{Parameters}
\docparam{bitmap}{The bitmap to set.}
\wxheading{See also}
\helpref{wxBitmapButton::GetBitmapSelected}{wxbitmapbuttongetbitmapselected},\rtfsp
\helpref{wxBitmapButton::SetBitmapLabel}{wxbitmapbuttonsetbitmaplabel},\rtfsp
\helpref{wxBitmapButton::SetBitmapFocus}{wxbitmapbuttonsetbitmapfocus},\rtfsp
\helpref{wxBitmapButton::SetBitmapDisabled}{wxbitmapbuttonsetbitmapdisabled}

View File

@@ -62,7 +62,7 @@ the user's input is valid, i.e. recognizable). }
\latexignore{\rtfignore{\wxheading{Members}}}
\membersection{wxColourPickerCtrl::wxColourPickerCtrl}\label{wxcolourpickerctrl}
\membersection{wxColourPickerCtrl::wxColourPickerCtrl}\label{wxcolourpickerctrlctor}
\func{}{wxColourPickerCtrl}{\param{wxWindow *}{parent},\rtfsp
\param{wxWindowID}{ id},\rtfsp

View File

@@ -83,7 +83,7 @@ functions that take a \helpref{wxCollapsiblePaneEvent}{wxcollapsiblepaneevent} a
\membersection{wxCollapsiblePane::wxCollapsiblePane}\label{wxcollapsiblepane}
\membersection{wxCollapsiblePane::wxCollapsiblePane}\label{wxcollapsiblepanector}
\func{}{wxCollapsiblePane}{\param{wxWindow *}{parent},\rtfsp
\param{wxWindowID}{ id},\rtfsp

View File

@@ -65,7 +65,7 @@ the user's input is valid, e.g. an existing directory path).}
\latexignore{\rtfignore{\wxheading{Members}}}
\membersection{wxDirPickerCtrl::wxDirPickerCtrl}\label{wxdirpickerctrl}
\membersection{wxDirPickerCtrl::wxDirPickerCtrl}\label{wxdirpickerctrlctor}
\func{}{wxDirPickerCtrl}{\param{wxWindow *}{parent},\rtfsp
\param{wxWindowID}{ id},\rtfsp

View File

@@ -71,7 +71,7 @@ was given).}
\latexignore{\rtfignore{\wxheading{Members}}}
\membersection{wxFilePickerCtrl::wxFilePickerCtrl}\label{wxfilepickerctrl}
\membersection{wxFilePickerCtrl::wxFilePickerCtrl}\label{wxfilepickerctrlctor}
\func{}{wxFilePickerCtrl}{\param{wxWindow *}{parent},\rtfsp
\param{wxWindowID}{ id},\rtfsp

View File

@@ -63,7 +63,7 @@ user's input is valid, i.e. recognizable). }
\latexignore{\rtfignore{\wxheading{Members}}}
\membersection{wxFontPickerCtrl::wxFontPickerCtrl}\label{wxfontpickerctrl}
\membersection{wxFontPickerCtrl::wxFontPickerCtrl}\label{wxfontpickerctrlctor}
\func{}{wxFontPickerCtrl}{\param{wxWindow *}{parent},\rtfsp
\param{wxWindowID}{ id},\rtfsp

View File

@@ -210,21 +210,21 @@ direct input to member function that take a
\latexignore{\rtfignore{\wxheading{Members}}}
\membersection{wxHyperlinkEvent::wxHyperlinkEvent}\label{wxhyperlinkctrlctor}
\membersection{wxHyperlinkEvent::wxHyperlinkEvent}\label{wxhyperlinkeventctor}
\func{}{wxHyperlinkEvent}{\param{wxObject *}{ generator}, \param{int}{ id}, \param{const wxString \&}{ url}}
The constructor is not normally used by the user code.
\membersection{wxHyperlinkEvent::GetURL}\label{wxhyperlinkctrlgeturl}
\membersection{wxHyperlinkEvent::GetURL}\label{wxhyperlinkeventgeturl}
\constfunc{wxString}{GetURL}{\void}
Returns the URL of the hyperlink where the user has just clicked.
\membersection{wxHyperlinkEvent::SetURL}\label{wxhyperlinkctrlseturl}
\membersection{wxHyperlinkEvent::SetURL}\label{wxhyperlinkeventseturl}
\func{void}{SetURL}{\param{const wxString \&}{ url}}

View File

@@ -126,7 +126,7 @@ unless you called DeleteContents({\tt true} ).
Appends the pointer to \rtfsp{\it object} to the list.
\membersection{wxList<T>::Clear}\label{wxlistclear}
\membersection{wxList<T>::Clear}\label{wxlistclear1}
\func{void}{Clear}{\void}
@@ -193,7 +193,7 @@ Returns the last iterator in the list (NULL if the list is empty).
Returns the index of {\it obj} within the list or {\tt wxNOT\_FOUND} if
{\it obj} is not found in the list.
\membersection{wxList<T>::Insert}\label{wxlistinsert}
\membersection{wxList<T>::Insert}\label{wxlistinsert1}
\func{wxList<T>::compatibility\_iterator}{Insert}{\param{T *}{object}}
@@ -340,25 +340,25 @@ Inserts an item (or several) at the given position.
Returns the largest possible size of the list.
\membersection{wxList<T>::pop\_back}\label{wxlistpop\_back}
\membersection{wxList<T>::pop\_back}\label{wxlistpopback}
\func{void}{pop\_back}{\void}
Removes the list item.
\membersection{wxList<T>::pop\_front}\label{wxlistpop\_front}
\membersection{wxList<T>::pop\_front}\label{wxlistpopfront}
\func{void}{pop\_front}{\void}
Removes the first item.
\membersection{wxList<T>::push\_back}\label{wxlistpush\_back}
\membersection{wxList<T>::push\_back}\label{wxlistpushback}
\func{void}{push\_back}{\param{const\_reference }{v = value\_type()}}
Adds an item to end of the list.
\membersection{wxList<T>::push\_front}\label{wxlistpush\_front}
\membersection{wxList<T>::push\_front}\label{wxlistpushfront}
\func{void}{push\_front}{\param{const\_reference }{v = value\_type()}}

View File

@@ -72,7 +72,7 @@ Constructs a wxModule object.
Destructor.
\membersection{wxModule::AddDependency}\label{wxmoduleoninit}
\membersection{wxModule::AddDependency}\label{wxmoduleadddependency}
\func{void}{AddDependency}{\param{wxClassInfo * }{dep}}

View File

@@ -139,11 +139,3 @@ This function can be used only when \helpref{HasTextCtrl}{wxpickerbasehastextctr
Returns \true if the picker control is growable.
\membersection{wxPickerBase::SetPickerCtrlGrowable}\label{wxpickerbasesetpickerctrlgrowable}
\func{void}{SetPickerCtrlGrowable}{\param{bool}{ grow = true}}
Sets the picker control as growable when {\tt grow} is \true.
This function has effects only when \helpref{HasTextCtrl}{wxpickerbasehastextctrl} returns \true.

View File

@@ -48,7 +48,7 @@ If {\it styleSheet} is specified, the base style for this definition will also b
This function finds the level (from 0 to 9) whose indentation attribute mostly closely matches {\it indent} (expressed in tenths of a millimetre).
\membersection{wxRichTextListStyleDefinition::GetCombinedStyle}\label{wxrichtextliststyledefinitioncombinewithparagraphstyle}
\membersection{wxRichTextListStyleDefinition::GetCombinedStyle}\label{wxrichtextliststyledefinitiongetcombinedstyle}
\constfunc{wxRichTextAttr}{GetCombinedStyle}{\param{int }{indent}, \param{wxRichTextStyleSheet*}{ styleSheet = NULL}}