Misc documentation fixes

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@25653 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Julian Smart 2004-02-08 18:48:55 +00:00
parent dc103d1a54
commit 461fb267e6
6 changed files with 12 additions and 12 deletions

View File

@ -13,9 +13,9 @@
# dll builds a library (wxdll.lib) suitable for creating DLLs
#
WXDIR=$(WXWIN)
THISDIR=$(WXWIN)\src\msw
THISDIR=$(WXWIN)\distrib\msw
DOCDIR = $(WXDIR)\docs
WAITFLAG=/w
# Making documents
docs: allhlp allhtml allpdfrtf allhtb allhtmlhelp
alldocs: docs

View File

@ -38,7 +38,7 @@ your \texttt{OnPaint()} handler, you should look at
\latexignore{\rtfignore{\wxheading{Members}}}
\membersection{wxBufferedDC::wxBufferedDC}\label{wxbufferedtdcctor}
\membersection{wxBufferedDC::wxBufferedDC}\label{wxbuffereddcctor}
\func{}{wxBufferedDC}{\void}
@ -47,7 +47,7 @@ your \texttt{OnPaint()} handler, you should look at
\func{}{wxBufferedDC}{\param{wxDC *}{dc}, \param{const wxBitmap\& }{buffer}}
If you use the first, default, constructor, you must call one of the
\helpref{Init}{wxbufferedtdcinit} methods later in order to use the object.
\helpref{Init}{wxbuffereddcinit} methods later in order to use the object.
The other constructors initialize the object immediately and \texttt{Init()}
must not be called after using them.
@ -71,14 +71,14 @@ time but it also requires more memory as the bitmap is never freed. The bitmap
should have appropriate size, anything drawn outside of its bounds is clipped.}
\membersection{wxBufferedDC::Init}\label{wxbufferedtdcinit}
\membersection{wxBufferedDC::Init}\label{wxbuffereddcinit}
\func{void}{Init}{\param{wxDC *}{dc}, \param{const wxSize\& }{area}, \param{int }{flags}}
\func{void}{Init}{\param{wxDC *}{dc}, \param{const wxBitmap\& }{buffer}}
These functions initialize the object created using the default constructor.
Please see \helpref{constructors documentation}{wxbufferedtdcctor} for details.
Please see \helpref{constructors documentation}{wxbuffereddcctor} for details.
% VZ: UnMask() intentionally not documented, we might want to make it private
@ -99,7 +99,7 @@ inside \texttt{OnPaint()} handler. Just create an object of this class instead
of \helpref{wxPaintDC}{wxpaintdc} and that's all you have to do to (mostly)
avoid flicker. The only thing to watch out for is that if you are using this
class together with \helpref{wxScrolledWindow}{wxscrolledwindow}, you probably
do \textbf{not} want to call \helpref{PrepareDC}{wxwindowpreparedc} on it as it
do \textbf{not} want to call \helpref{PrepareDC}{wxscrolledwindowpreparedc} on it as it
already does this internally for the real underlying wxPaintDC.
\wxheading{Derived from}

View File

@ -54,7 +54,7 @@ Default constructor.
\param{wxColour*}{ fg=NULL}, \param{wxColour*}{ bg=NULL}}
Constructs a cursor by passing an array of bits (Motif and GTK+ only). {\it maskBits} is used only under
Motif and GTK+. The parameters {\it fg} and {\bg } are only present on GTK+, and force the
Motif and GTK+. The parameters {\it fg} and {\it bg} are only present on GTK+, and force the
cursor to use particular background and foreground colours.
If either {\it hotSpotX} or {\it hotSpotY} is -1, the hotspot will be the centre of the cursor image (Motif only).

View File

@ -395,7 +395,7 @@ of wxPoint objects.}
\membersection{wxDC::DrawPolyPolygon}\label{wxdcdrawpolypolygon}
\func{void}{DrawPolyPolygon}{\param{int }{n}, \param{int }{start\[\]}, \param{wxPoint }{points\[\]}, \param{wxCoord }{xoffset}, \param{wxCoord }{yoffset}, \param{int }{fillStyle = \texttt{wxODDEVEN\_RULE}}}
\func{void}{DrawPolyPolygon}{\param{int }{n}, \param{int }{start[]}, \param{wxPoint }{points[]}, \param{wxCoord }{xoffset}, \param{wxCoord }{yoffset}, \param{int }{fillStyle = \texttt{wxODDEVEN\_RULE}}}
Draw many polygons at once. For the platforms providing a native implementation
of this function (Windows and PostScript-based wxDC), this is more efficient

View File

@ -134,7 +134,7 @@ On IPV6 implementations, ::1
Returns true on success, false if something went wrong.
\membersection{wxIPaddress::LocalHost}\label{wxIPaddresslocalhost}
\membersection{wxIPaddress::IsLocalHost}\label{wxIPaddressislocalhost}
\func{virtual bool}{IsLocalHost}{\void}

View File

@ -813,7 +813,7 @@ sequence in the native control.
This function finds the character at the specified position expressed in
pixels. If the return code is not \texttt{wxTE\_HT\_UNKNOWN} the row and column
of the character closest to this position are returned in the \arg{col} and
\arg{row} parameters (unless the pointers are \textt{NULL} which is allowed).
\arg{row} parameters (unless the pointers are \tt{NULL} which is allowed).
Please note that this function is currently only implemented in wxUniv and
wxMSW ports.