Made documentation for wxImage::GetData/SetData more explicit about

[wxWidgets.git] / docs / latex / wx / plotcurve.tex

diff --git a/docs/latex/wx/plotcurve.tex b/docs/latex/wx/plotcurve.tex
index 2d166be636e130e4938beb63330222e4ec8d19ad..a6c375b4db13faf5045dd51ef79290642e922a1c 100644 (file)
--- a/docs/latex/wx/plotcurve.tex
+++ b/docs/latex/wx/plotcurve.tex
@@ -26,13 +26,6 @@ and \helpref{GetY()}{wxplotcurvegety}).
 
 Constructor assigning start values. See below for interpretation.
 
-\membersection{wxPlotCurve::GetStartX}\label{wxplotcurvegetstartx}
-
-\func{wxInt32}{GetStartX}{\void}
-
-Must be overridden. This function should return the index of the first value
-of this curve, typically zero.
-
 \membersection{wxPlotCurve::GetEndX}\label{wxplotcurvegetendx}
 
 \func{wxInt32}{GetEndX}{\void}
@@ -40,6 +33,17 @@ of this curve, typically zero.
 Must be overridden. This function should return the index of the last value
 of this curve, typically 99 if 100 values have been measured.
 
+\membersection{wxPlotCurve::GetEndY}\label{wxplotcurvegetendy}
+
+\func{double}{GetEndY}{\void}
+
+See \helpref{SetStartY}{wxplotcurvesetendy}.
+
+\membersection{wxPlotCurve::GetOffsetY}\label{wxplotcurvegetoffsety}
+
+\func{int}{GetOffsetY}{\void}
+
+Returns the vertical offset.
 \membersection{wxPlotCurve::GetY}\label{wxplotcurvegety}
 
 \func{double}{GetY}{\param{wxInt32 }{x}}
@@ -48,14 +52,12 @@ Must be overridden. This function will return the actual Y value corresponding
 to the given X value. The x value is of an integer type because it is considered
 to be an index in row of measured values.
 
-\membersection{wxPlotCurve::SetStartY}\label{wxplotcurvesetstarty}
+\membersection{wxPlotCurve::GetStartX}\label{wxplotcurvegetstartx}
 
-\func{void}{SetStartY}{\param{double }{startY}}
+\func{wxInt32}{GetStartX}{\void}
 
-The value returned by this function tells the plot window what the lowest values
-in the curve will be os that a suitable scale can be found for the display. If
-the Y values in this curve are in the range of -1.5 to 0.5, this function should
-return -1.5 or maybe -2.0 for nicer optics.
+Must be overridden. This function should return the index of the first value
+of this curve, typically zero.
 
 \membersection{wxPlotCurve::GetStartY}\label{wxplotcurvegetstarty}
 
@@ -68,26 +70,24 @@ See \helpref{SetStartY}{wxplotcurvesetstarty}.
 \func{void}{SetEndY}{\param{double }{endY}}
 
 The value returned by this function tells the plot window what the highest values
-in the curve will be os that a suitable scale can be found for the display. If
+in the curve will be so that a suitable scale can be found for the display. If
 the Y values in this curve are in the range of -1.5 to 0.5, this function should
-return 0.5 or maybe 1.0 for nicer optics.
-
-\membersection{wxPlotCurve::GetEndY}\label{wxplotcurvegetendy}
-
-\func{double}{GetEndY}{\void}
-
-See \helpref{SetStartY}{wxplotcurvesetendy}.
+return 0.5 or maybe 1.0 for nicer aesthetics.
 
 \membersection{wxPlotCurve::SetOffsetY}\label{wxplotcurvesetoffsety}
 
 \func{void}{SetOffsetY}{\param{int }{offsetY}}
 
 When displaying several curves in one window, it is often useful to assign
-different offsets to the curves. You should call \helpref{wxPlotWindow::Move}{wxplotwindowmove}
+different offsets to the curves. You should call \helpref{wxPlotWindow::Move}{wxplotwindowmove} 
 to set this value after you have added the curve to the window.
 
-\membersection{wxPlotCurve::GetOffsetY}\label{wxplotcurvegetoffsety}
+\membersection{wxPlotCurve::SetStartY}\label{wxplotcurvesetstarty}
 
-\func{int}{GetOffsetY}{\void}
+\func{void}{SetStartY}{\param{double }{startY}}
+
+The value returned by this function tells the plot window what the lowest values
+in the curve will be so that a suitable scale can be found for the display. If
+the Y values in this curve are in the range of -1.5 to 0.5, this function should
+return -1.5 or maybe -2.0 for nicer aesthetics.
 
-Returns the vertical offset.