Skip to content
GitLab
Commit 887a0cd5 authored by Uwe Schulzweida's avatar Uwe Schulzweida
Browse files

Docu update

parent 23758023
Hide whitespace changes
Inline Side-by-side
doc/tex/c_grid.tex
View file @ 887a0cd5
......@@ -294,7 +294,8 @@ The function {\tt gridInqXvals} returns all values of the X-axis.
\item[{\tt gridID}]
Grid ID, from a previous call to {\htmlref{\tt gridCreate}{gridCreate}}.
\item[{\tt xvals}]
X-values of the grid.
Pointer to the location into which the X-values are read.
The caller must allocate space for the returned values.
\end{deflist}
\end{minipage}
......@@ -347,7 +348,8 @@ The function {\tt gridInqYvals} returns all values of the Y-axis.
\item[{\tt gridID}]
Grid ID, from a previous call to {\htmlref{\tt gridCreate}{gridCreate}}.
\item[{\tt yvals}]
Y-values of the grid.
Pointer to the location into which the Y-values are read.
The caller must allocate space for the returned values.
\end{deflist}
\end{minipage}
......@@ -400,7 +402,8 @@ The function {\tt gridInqXbounds} returns the bounds of the X-axis.
\item[{\tt gridID}]
Grid ID, from a previous call to {\htmlref{\tt gridCreate}{gridCreate}}.
\item[{\tt xbounds}]
X-bounds of the grid.
Pointer to the location into which the X-bounds are read.
The caller must allocate space for the returned values.
\end{deflist}
\end{minipage}
......@@ -453,7 +456,8 @@ The function {\tt gridInqYbounds} returns the bounds of the Y-axis.
\item[{\tt gridID}]
Grid ID, from a previous call to {\htmlref{\tt gridCreate}{gridCreate}}.
\item[{\tt ybounds}]
Y-bounds of the grid.
Pointer to the location into which the Y-bounds are read.
The caller must allocate space for the returned values.
\end{deflist}
\end{minipage}
......
doc/tex/c_stream.tex
View file @ 887a0cd5
......@@ -378,7 +378,8 @@ Stream ID, from a previous call to {\htmlref{\tt streamOpenRead}{streamOpenRead}
\item[{\tt varID}]
Variable identifier.
\item[{\tt data}]
Pointer to the location into which the data value is read.
Pointer to the location into which the data values are read.
The caller must allocate space for the returned values.
\item[{\tt nmiss}]
Number of missing values.
......@@ -438,7 +439,8 @@ Variable identifier.
\item[{\tt levelID}]
Level identifier.
\item[{\tt data}]
Pointer to the location into which the data value is read.
Pointer to the location into which the data values are read.
The caller must allocate space for the returned values.
\item[{\tt nmiss}]
Number of missing values.
......
doc/tex/c_zaxis.tex
View file @ 887a0cd5
......@@ -163,7 +163,8 @@ The function {\tt zaxisInqLevels} returns all levels of a Z-axis.
\item[{\tt zaxisID}]
Z-axis ID, from a previous call to {\htmlref{\tt zaxisCreate}{zaxisCreate}}.
\item[{\tt levels}]
Levels of the Z-axis.
Pointer to the location into which the levels are read.
The caller must allocate space for the returned values.
\end{deflist}
\end{minipage}
......
doc/tex/cdi_cman.tex
View file @ 887a0cd5
......@@ -135,7 +135,7 @@
\end{picture}
\begin{flushright}
\large\bf{Climate Data Interface \\ Version 1.5.0 \\ March 2011}
\large\bf{Climate Data Interface \\ Version 1.5.1 \\ June 2011}
\end{flushright}
\vfill
......
doc/tex/cdi_fman.tex
View file @ 887a0cd5
......@@ -132,7 +132,7 @@
\end{picture}
\begin{flushright}
\large\bf{Climate Data Interface \\ Version 1.5.0 \\ March 2011}
\large\bf{Climate Data Interface \\ Version 1.5.1 \\ June 2011}
\end{flushright}
\vfill
......
doc/tex/f_grid.tex
View file @ 887a0cd5
......@@ -294,7 +294,8 @@ The function {\tt gridInqXvals} returns all values of the X-axis.
\item[{\tt gridID}]
Grid ID, from a previous call to {\htmlref{\tt gridCreate}{gridCreate}}.
\item[{\tt xvals}]
X-values of the grid.
Pointer to the location into which the X-values are read.
The caller must allocate space for the returned values.
\end{deflist}
\end{minipage}
......@@ -347,7 +348,8 @@ The function {\tt gridInqYvals} returns all values of the Y-axis.
\item[{\tt gridID}]
Grid ID, from a previous call to {\htmlref{\tt gridCreate}{gridCreate}}.
\item[{\tt yvals}]
Y-values of the grid.
Pointer to the location into which the Y-values are read.
The caller must allocate space for the returned values.
\end{deflist}
\end{minipage}
......@@ -400,7 +402,8 @@ The function {\tt gridInqXbounds} returns the bounds of the X-axis.
\item[{\tt gridID}]
Grid ID, from a previous call to {\htmlref{\tt gridCreate}{gridCreate}}.
\item[{\tt xbounds}]
X-bounds of the grid.
Pointer to the location into which the X-bounds are read.
The caller must allocate space for the returned values.
\end{deflist}
\end{minipage}
......@@ -453,7 +456,8 @@ The function {\tt gridInqYbounds} returns the bounds of the Y-axis.
\item[{\tt gridID}]
Grid ID, from a previous call to {\htmlref{\tt gridCreate}{gridCreate}}.
\item[{\tt ybounds}]
Y-bounds of the grid.
Pointer to the location into which the Y-bounds are read.
The caller must allocate space for the returned values.
\end{deflist}
\end{minipage}
......
doc/tex/f_stream.tex
View file @ 887a0cd5
......@@ -380,7 +380,8 @@ Stream ID, from a previous call to {\htmlref{\tt streamOpenRead}{streamOpenRead}
\item[{\tt varID}]
Variable identifier.
\item[{\tt data}]
Pointer to the location into which the data value is read.
Pointer to the location into which the data values are read.
The caller must allocate space for the returned values.
\item[{\tt nmiss}]
Number of missing values.
......@@ -440,7 +441,8 @@ Variable identifier.
\item[{\tt levelID}]
Level identifier.
\item[{\tt data}]
Pointer to the location into which the data value is read.
Pointer to the location into which the data values are read.
The caller must allocate space for the returned values.
\item[{\tt nmiss}]
Number of missing values.
......
doc/tex/f_zaxis.tex
View file @ 887a0cd5
......@@ -163,7 +163,8 @@ The function {\tt zaxisInqLevels} returns all levels of a Z-axis.
\item[{\tt zaxisID}]
Z-axis ID, from a previous call to {\htmlref{\tt zaxisCreate}{zaxisCreate}}.
\item[{\tt levels}]
Levels of the Z-axis.
Pointer to the location into which the levels are read.
The caller must allocate space for the returned values.
\end{deflist}
\end{minipage}
......
src/grid.c
View file @ 887a0cd5
......@@ -1496,7 +1496,8 @@ void gridDefMaskGME(int gridID, const int *mask)
@Prototype int gridInqXvals(int gridID, double *xvals)
@Parameter
@Item gridID Grid ID, from a previous call to @fref{gridCreate}.
@Item xvals X-values of the grid.
@Item xvals Pointer to the location into which the X-values are read.
The caller must allocate space for the returned values.
@Description
The function @func{gridInqXvals} returns all values of the X-axis.
......@@ -1584,7 +1585,8 @@ void gridDefXvals(int gridID, const double *xvals)
@Prototype int gridInqYvals(int gridID, double *yvals)
@Parameter
@Item gridID Grid ID, from a previous call to @fref{gridCreate}.
@Item yvals Y-values of the grid.
@Item yvals Pointer to the location into which the Y-values are read.
The caller must allocate space for the returned values.
@Description
The function @func{gridInqYvals} returns all values of the Y-axis.
......@@ -2979,7 +2981,8 @@ void gridDefXbounds(int gridID, const double *xbounds)
@Prototype int gridInqXbounds(int gridID, double *xbounds)
@Parameter
@Item gridID Grid ID, from a previous call to @fref{gridCreate}.
@Item xbounds X-bounds of the grid.
@Item xbounds Pointer to the location into which the X-bounds are read.
The caller must allocate space for the returned values.
@Description
The function @func{gridInqXbounds} returns the bounds of the X-axis.
......@@ -3089,7 +3092,8 @@ void gridDefYbounds(int gridID, const double *ybounds)
@Prototype int gridInqYbounds(int gridID, double *ybounds)
@Parameter
@Item gridID Grid ID, from a previous call to @fref{gridCreate}.
@Item ybounds Y-bounds of the grid.
@Item ybounds Pointer to the location into which the Y-bounds are read.
The caller must allocate space for the returned values.
@Description
The function @func{gridInqYbounds} returns the bounds of the Y-axis.
......
src/stream.c
View file @ 887a0cd5
......@@ -1454,7 +1454,8 @@ int streamInqTimestep(int streamID, int tsID)
@Parameter
@Item streamID Stream ID, from a previous call to @fref{streamOpenRead} or @fref{streamOpenWrite}.
@Item varID Variable identifier.
@Item data Pointer to the location into which the data value is read.
@Item data Pointer to the location into which the data values are read.
The caller must allocate space for the returned values.
@Item nmiss Number of missing values.
@Description
......@@ -1618,7 +1619,8 @@ void streamWriteVar(int streamID, int varID, const double *data, int nmiss)
@Item streamID Stream ID, from a previous call to @fref{streamOpenRead} or @fref{streamOpenWrite}.
@Item varID Variable identifier.
@Item levelID Level identifier.
@Item data Pointer to the location into which the data value is read.
@Item data Pointer to the location into which the data values are read.
The caller must allocate space for the returned values.
@Item nmiss Number of missing values.
@Description
......
src/zaxis.c
View file @ 887a0cd5
......@@ -809,7 +809,8 @@ const double *zaxisInqLevelsPtr(int zaxisID)
@Prototype void zaxisInqLevels(int zaxisID, double *levels)
@Parameter
@Item zaxisID Z-axis ID, from a previous call to @fref{zaxisCreate}.
@Item levels Levels of the Z-axis.
@Item levels Pointer to the location into which the levels are read.
The caller must allocate space for the returned values.
@Description
The function @func{zaxisInqLevels} returns all levels of a Z-axis.
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment

Imprint | Privacy Policy