From 0d84e48df09ba9f48c62850c4cef43c2cee0f6a0 Mon Sep 17 00:00:00 2001
From: Uwe Schulzweida <uwe.schulzweida@mpimet.mpg.de>
Date: Thu, 25 May 2006 16:05:00 +0000
Subject: [PATCH] Docu update
---
README | 23 ++++++++++++++++++-----
doc/tex/c_examples.tex | 4 ++--
doc/tex/c_grid.tex | 10 +++++-----
doc/tex/c_link.tex | 10 +++++-----
doc/tex/c_stream.tex | 12 ++++++------
doc/tex/c_taxis.tex | 32 ++++++++++++++++----------------
doc/tex/c_vlist.tex | 2 +-
doc/tex/c_vlist_var.tex | 8 ++++----
doc/tex/c_zaxis.tex | 8 ++++----
doc/tex/dataset.tex | 6 ++++--
doc/tex/f_examples.tex | 4 ++--
doc/tex/f_grid.tex | 10 +++++-----
doc/tex/f_link.tex | 10 +++++-----
doc/tex/f_stream.tex | 12 ++++++------
doc/tex/f_taxis.tex | 32 ++++++++++++++++----------------
doc/tex/f_vlist.tex | 2 +-
doc/tex/f_vlist_var.tex | 8 ++++----
doc/tex/f_zaxis.tex | 8 ++++----
doc/tex/formats.tex | 19 ++++++++++++-------
doc/tex/install.tex | 18 +++++++-----------
doc/tex/makedoc | 1 +
doc/tex/modules.tex | 2 +-
doc/tex/taxis.tex | 3 ++-
doc/tex/usage.tex | 13 +++++++++----
doc/tex/variable.tex | 3 +++
src/grid.c | 2 +-
src/taxis.c | 20 ++++++++++----------
src/vlist.c | 2 +-
28 files changed, 155 insertions(+), 129 deletions(-)
diff --git a/README b/README
index 89b091328..27d341788 100644
--- a/README
+++ b/README
@@ -7,15 +7,28 @@ CDI - Climate Data Interface
CDI is a C and Fortran Interface to access Climate model Data.
Supported file formats are GRIB, netCDF, SERVICE, EXTRA and IEG.
+ CDI is licensed under the GNU General Public License, version 2.
+ Read the file COPYING in the source distribution for details.
+
Documentation:
- Not available.
+ ANSI C Manual: ./doc/cdi_cman.pdf
+ Fortran Manual: ./doc/cdi_fman.pdf
Installation:
- Read INSTALL on how to configure, compile and install the library.
- The configuration script has some more environment variables.
- Type 'configure -h' to see them.
+ 1. Run ./configure, with some options if you wish. The standard
+ options are documented in the INSTALL file. The configuration
+ script has some more options; type 'configure -h' to see them.
+ The most interesting ones are the usual
+ --prefix=<installation directory> and
+ --with-netcdf=<netCDF root directory> to enable netCDF support.
+
+ 2. Do "make" to compile the library.
+
+ 3. (Optional) Do "make install", possibly as root if the destination
+ permissions require that. This installs CDI in the directory
+ specified during configuration. The default prefix is /usr/local.
Porting:
@@ -27,5 +40,5 @@ Porting:
Contact:
- Send questions, comments and bug reports to schulzweida@dkrz.de
+ Send questions, comments and bug reports to Uwe.Schulzweida@zmaw.de
diff --git a/doc/tex/c_examples.tex b/doc/tex/c_examples.tex
index 6c61c184f..3eade6c13 100644
--- a/doc/tex/c_examples.tex
+++ b/doc/tex/c_examples.tex
@@ -1,12 +1,12 @@
\chapter{\label{example}Examples}
This appendix contains complete examples to write, read
-and copy a dataset with the CDI library.
+and copy a dataset with the \CDI library.
\section{\label{example_write}Write a dataset}
-Here is an example using CDI to write a netCDF dataset with
+Here is an example using \CDI to write a netCDF dataset with
2 variables on 3 time steps. The first variable is a 2D field
on surface level and the second variable is a 3D field on 5 pressure
levels. Both variables are on the same lon/lat grid.
diff --git a/doc/tex/c_grid.tex b/doc/tex/c_grid.tex
index ee7c6b14f..d0e544470 100644
--- a/doc/tex/c_grid.tex
+++ b/doc/tex/c_grid.tex
@@ -15,8 +15,8 @@ The function {\tt gridCreate} creates a horizontal Grid.
\hspace*{4mm}\begin{minipage}[]{15cm}
\begin{deflist}{\tt gridtype\ }
\item[{\tt gridtype}]
-The type of the grid, one of the set of predefined CDI grid types.
- The valid CDI grid types are {\tt GRID\_GENERIC}, {\tt GRID\_GAUSSIAN},
+The type of the grid, one of the set of predefined \CDI grid types.
+ The valid \CDI grid types are {\tt GRID\_GENERIC}, {\tt GRID\_GAUSSIAN},
{\tt GRID\_LONLAT}, {\tt GRID\_SPECTRAL}, {\tt GRID\_GME},
{\tt GRID\_CURVILINEAR} and {\tt GRID\_CELL}.
\item[{\tt size}]
@@ -88,7 +88,7 @@ The function {\tt gridDuplicate} duplicates a horizontal Grid.
\begin{deflist}{\tt gridID\ }
\item[{\tt gridID}]
Grid ID, from a previous call to {\htmlref{\tt gridCreate}{gridCreate}},
- {\tt gridDuplicate} or {\tt vlistInqVarGrid}.
+ {\htmlref{\tt gridDuplicate}{gridDuplicate}} or {\htmlref{\tt vlistInqVarGrid}{vlistInqVarGrid}}.
\end{deflist}
\end{minipage}
@@ -122,8 +122,8 @@ Grid ID, from a previous call to {\htmlref{\tt gridCreate}{gridCreate}}
\subsubsection*{Result}
{\tt gridInqType} returns the type of the grid,
-one of the set of predefined CDI grid types.
-The valid CDI grid types are {\tt GRID\_GENERIC}, {\tt GRID\_GAUSSIAN},
+one of the set of predefined \CDI grid types.
+The valid \CDI grid types are {\tt GRID\_GENERIC}, {\tt GRID\_GAUSSIAN},
{\tt GRID\_LONLAT}, {\tt GRID\_SPECTRAL}, {\tt GRID\_GME}, {\tt GRID\_CURVILINEAR}
and {\tt GRID\_CELL}.
diff --git a/doc/tex/c_link.tex b/doc/tex/c_link.tex
index 4b5e72227..3342322aa 100644
--- a/doc/tex/c_link.tex
+++ b/doc/tex/c_link.tex
@@ -1,4 +1,4 @@
-Every C file that references CDI functions or constants must contain
+Every C file that references \CDI functions or constants must contain
an appropriate {\tt include} statement before the first such reference:
\begin{verbatim}
@@ -15,11 +15,11 @@ the compiler, to specify a directory where {\tt cdi.h} is installed, for example
Alternatively, you could specify an absolute path name in the {\tt include}
statement, but then your program would not compile on another platform
-where CDI is installed in a different location.
+where \CDI is installed in a different location.
-Unless the CDI library is installed in a standard directory where the linker
+Unless the \CDI library is installed in a standard directory where the linker
always looks, you must use the {\tt -L} and {\tt -l} options to links an object file that
-uses the CDI library. For example:
+uses the \CDI library. For example:
\begin{verbatim}
cc -o myprogram myprogram.o -L/usr/local/cdi/lib -lcdi -lm
@@ -31,7 +31,7 @@ Alternatively, you could specify an absolute path name for the library:
cc -o myprogram myprogram.o -L/usr/local/cdi/lib/libcdi -lm
\end{verbatim}
-If the CDI library is using other external libraries, you must add this
+If the \CDI library is using other external libraries, you must add this
libraries in the same way.
For example with the netCDF library:
diff --git a/doc/tex/c_stream.tex b/doc/tex/c_stream.tex
index 67a055954..1b7e28658 100644
--- a/doc/tex/c_stream.tex
+++ b/doc/tex/c_stream.tex
@@ -16,8 +16,8 @@ The function {\tt streamOpenWrite} creates a new datset.
\item[{\tt path}]
The name of the new dataset
\item[{\tt filetype}]
-The type of the file format, one of the set of predefined CDI file format types.
- The valid CDI file format types are {\tt FILETYPE\_GRB}, {\tt FILETYPE\_NC},
+The type of the file format, one of the set of predefined \CDI file format types.
+ The valid \CDI file format types are {\tt FILETYPE\_GRB}, {\tt FILETYPE\_NC},
{\tt FILETYPE\_NC2}, {\tt FILETYPE\_SRV}, {\tt FILETYPE\_EXT} and {\tt FILETYPE\_IEG}.
\end{deflist}
@@ -167,8 +167,8 @@ Stream ID, from a previous call to {\htmlref{\tt streamOpenRead}{streamOpenRead}
\subsubsection*{Result}
{\tt streamInqFiletype} returns the type of the file format,
-one of the set of predefined CDI file format types.
-The valid CDI file format types are {\tt FILETYPE\_GRB}, {\tt FILETYPE\_NC},
+one of the set of predefined \CDI file format types.
+The valid \CDI file format types are {\tt FILETYPE\_GRB}, {\tt FILETYPE\_NC},
{\tt FILETYPE\_NC2}, {\tt FILETYPE\_SRV}, {\tt FILETYPE\_EXT} and {\tt FILETYPE\_IEG}.
@@ -191,7 +191,7 @@ with the file format type {\tt FILETYPE\_SRV}, {\tt FILETYPE\_EXT} or {\tt FILET
\item[{\tt streamID}]
Stream ID, from a previous call to {\htmlref{\tt streamOpenRead}{streamOpenRead}} or {\htmlref{\tt streamOpenWrite}{streamOpenWrite}}
\item[{\tt byteorder}]
-The byte order of a dataset, one of the CDI constants {\tt CDI\_BIGENDIAN} and
+The byte order of a dataset, one of the \CDI constants {\tt CDI\_BIGENDIAN} and
{\tt CDI\_LITTLEENDIAN}.
\end{deflist}
@@ -222,7 +222,7 @@ Stream ID, from a previous call to {\htmlref{\tt streamOpenRead}{streamOpenRead}
\subsubsection*{Result}
{\tt streamInqByteorder} returns the type of the byte order.
-The valid CDI byte order types are {\tt CDI\_BIGENDIAN} and {\tt CDI\_LITTLEENDIAN}
+The valid \CDI byte order types are {\tt CDI\_BIGENDIAN} and {\tt CDI\_LITTLEENDIAN}
diff --git a/doc/tex/c_taxis.tex b/doc/tex/c_taxis.tex
index b8fdf6676..02ef3b940 100644
--- a/doc/tex/c_taxis.tex
+++ b/doc/tex/c_taxis.tex
@@ -15,8 +15,8 @@ The function {\tt taxisCreate} creates a Time axis.
\hspace*{4mm}\begin{minipage}[]{15cm}
\begin{deflist}{\tt taxistype\ }
\item[{\tt taxistype}]
-The type of the Time axis, one of the set of predefined CDI time axis types.
- The valid CDI time axis types are {\tt TAXIS\_ABSOLUTE} and {\tt TAXIS\_RELATIVE}.
+The type of the Time axis, one of the set of predefined \CDI time axis types.
+ The valid \CDI time axis types are {\tt TAXIS\_ABSOLUTE} and {\tt TAXIS\_RELATIVE}.
\end{deflist}
\end{minipage}
@@ -78,7 +78,7 @@ The function {\tt taxisDefVdate} defines the reference date of a Time axis.
\hspace*{4mm}\begin{minipage}[]{15cm}
\begin{deflist}{\tt taxisID\ }
\item[{\tt taxisID}]
-Time axis ID, from a previous call to {\tt taxisCreate}
+Time axis ID, from a previous call to {\htmlref{\tt taxisCreate}{taxisCreate}}
\item[{\tt rdate}]
Reference date (YYYYMMDD)
@@ -101,7 +101,7 @@ The function {\tt taxisInqRdate} returns the reference date of a Time axis.
\hspace*{4mm}\begin{minipage}[]{15cm}
\begin{deflist}{\tt taxisID\ }
\item[{\tt taxisID}]
-Time axis ID, from a previous call to {\tt taxisCreate}
+Time axis ID, from a previous call to {\htmlref{\tt taxisCreate}{taxisCreate}}
\end{deflist}
\end{minipage}
@@ -127,7 +127,7 @@ The function {\tt taxisDefVdate} defines the reference time of a Time axis.
\hspace*{4mm}\begin{minipage}[]{15cm}
\begin{deflist}{\tt taxisID\ }
\item[{\tt taxisID}]
-Time axis ID, from a previous call to {\tt taxisCreate}
+Time axis ID, from a previous call to {\htmlref{\tt taxisCreate}{taxisCreate}}
\item[{\tt rtime}]
Reference time (HHMM)
@@ -150,7 +150,7 @@ The function {\tt taxisInqRtime} returns the reference time of a Time axis.
\hspace*{4mm}\begin{minipage}[]{15cm}
\begin{deflist}{\tt taxisID\ }
\item[{\tt taxisID}]
-Time axis ID, from a previous call to {\tt taxisCreate}
+Time axis ID, from a previous call to {\htmlref{\tt taxisCreate}{taxisCreate}}
\end{deflist}
\end{minipage}
@@ -176,7 +176,7 @@ The function {\tt taxisDefVdate} defines the verification date of a Time axis.
\hspace*{4mm}\begin{minipage}[]{15cm}
\begin{deflist}{\tt taxisID\ }
\item[{\tt taxisID}]
-Time axis ID, from a previous call to {\tt taxisCreate}
+Time axis ID, from a previous call to {\htmlref{\tt taxisCreate}{taxisCreate}}
\item[{\tt vdate}]
Verification date (YYYYMMDD)
@@ -199,7 +199,7 @@ The function {\tt taxisInqVdate} returns the verification date of a Time axis.
\hspace*{4mm}\begin{minipage}[]{15cm}
\begin{deflist}{\tt taxisID\ }
\item[{\tt taxisID}]
-Time axis ID, from a previous call to {\tt taxisCreate}
+Time axis ID, from a previous call to {\htmlref{\tt taxisCreate}{taxisCreate}}
\end{deflist}
\end{minipage}
@@ -225,7 +225,7 @@ The function {\tt taxisDefVtime} defines the verification time of a Time axis.
\hspace*{4mm}\begin{minipage}[]{15cm}
\begin{deflist}{\tt taxisID\ }
\item[{\tt taxisID}]
-Time axis ID, from a previous call to {\tt taxisCreate}
+Time axis ID, from a previous call to {\htmlref{\tt taxisCreate}{taxisCreate}}
\item[{\tt vtime}]
Verification time (HHMM)
@@ -248,7 +248,7 @@ The function {\tt taxisInqVtime} returns the verification time of a Time axis.
\hspace*{4mm}\begin{minipage}[]{15cm}
\begin{deflist}{\tt taxisID\ }
\item[{\tt taxisID}]
-Time axis ID, from a previous call to {\tt taxisCreate}
+Time axis ID, from a previous call to {\htmlref{\tt taxisCreate}{taxisCreate}}
\end{deflist}
\end{minipage}
@@ -274,10 +274,10 @@ The function {\tt taxisDefCalendar} defines the calendar of a Time axis.
\hspace*{4mm}\begin{minipage}[]{15cm}
\begin{deflist}{\tt calendar\ }
\item[{\tt taxisID}]
-Time axis ID, from a previous call to {\tt taxisCreate}
+Time axis ID, from a previous call to {\htmlref{\tt taxisCreate}{taxisCreate}}
\item[{\tt calendar}]
-The type of the calendar, one of the set of predefined CDI calendar types.
- The valid CDI calendar types are {\tt CALENDAR\_STANDARD}, {\tt CALENDAR\_360DAYS},
+The type of the calendar, one of the set of predefined \CDI calendar types.
+ The valid \CDI calendar types are {\tt CALENDAR\_STANDARD}, {\tt CALENDAR\_360DAYS},
{\tt CALENDAR\_365DAYS} and {\tt CALENDAR\_366DAYS}.
\end{deflist}
@@ -299,7 +299,7 @@ The function {\tt taxisInqCalendar} returns the calendar of a Time axis.
\hspace*{4mm}\begin{minipage}[]{15cm}
\begin{deflist}{\tt taxisID\ }
\item[{\tt taxisID}]
-Time axis ID, from a previous call to {\tt taxisCreate}
+Time axis ID, from a previous call to {\htmlref{\tt taxisCreate}{taxisCreate}}
\end{deflist}
\end{minipage}
@@ -307,7 +307,7 @@ Time axis ID, from a previous call to {\tt taxisCreate}
\subsubsection*{Result}
{\tt taxisInqCalendar} returns the type of the calendar,
-one of the set of predefined CDI calendar types.
-The valid CDI calendar types are {\tt CALENDAR\_STANDARD}, {\tt CALENDAR\_360DAYS},
+one of the set of predefined \CDI calendar types.
+The valid \CDI calendar types are {\tt CALENDAR\_STANDARD}, {\tt CALENDAR\_360DAYS},
{\tt CALENDAR\_365DAYS} and {\tt CALENDAR\_366DAYS}.
diff --git a/doc/tex/c_vlist.tex b/doc/tex/c_vlist.tex
index 8ebd3e3c0..be13ed4a6 100644
--- a/doc/tex/c_vlist.tex
+++ b/doc/tex/c_vlist.tex
@@ -238,7 +238,7 @@ The function {\tt vlistDefTaxis} defines the time axis of a variable list.
\item[{\tt vlistID}]
Variable list ID, from a previous call to {\htmlref{\tt vlistCreate}{vlistCreate}}
\item[{\tt taxisID}]
-Time axis ID, from a previous call to {\tt taxisCreate}
+Time axis ID, from a previous call to {\htmlref{\tt taxisCreate}{taxisCreate}}
\end{deflist}
\end{minipage}
diff --git a/doc/tex/c_vlist_var.tex b/doc/tex/c_vlist_var.tex
index b4001ac60..7f8bbe184 100644
--- a/doc/tex/c_vlist_var.tex
+++ b/doc/tex/c_vlist_var.tex
@@ -21,8 +21,8 @@ Grid ID, from a previous call to {\htmlref{\tt gridCreate}{gridCreate}}
\item[{\tt zaxisID}]
Z-axis ID, from a previous call to {\htmlref{\tt zaxisCreate}{zaxisCreate}}
\item[{\tt timeID}]
-One of the set of predefined CDI time identifiers.
- The valid CDI time identifiers are {\tt TIME\_CONSTANT} and {\tt TIME\_VARIABLE}.
+One of the set of predefined \CDI time identifiers.
+ The valid \CDI time identifiers are {\tt TIME\_CONSTANT} and {\tt TIME\_VARIABLE}.
\end{deflist}
\end{minipage}
@@ -291,7 +291,7 @@ Variable list ID, from a previous call to {\htmlref{\tt vlistCreate}{vlistCreate
Variable identifier
\item[{\tt datatype}]
The data type identifier.
- The valid CDI data types are {\tt DATATYPE\_PACK1}, {\tt DATATYPE\_PACK2},
+ The valid \CDI data types are {\tt DATATYPE\_PACK1}, {\tt DATATYPE\_PACK2},
{\tt DATATYPE\_PACK3}, {\tt DATATYPE\_REAL4} and {\tt DATATYPE\_REAL8}.
@@ -324,7 +324,7 @@ Variable identifier
\subsubsection*{Result}
{\tt vlistInqVarDatatype} returns an identifier to the data type of the variable.
-The valid CDI data types are {\tt DATATYPE\_PACK1}, {\tt DATATYPE\_PACK2}, {\tt DATATYPE\_PACK3},
+The valid \CDI data types are {\tt DATATYPE\_PACK1}, {\tt DATATYPE\_PACK2}, {\tt DATATYPE\_PACK3},
{\tt DATATYPE\_REAL4} and {\tt DATATYPE\_REAL8}.
diff --git a/doc/tex/c_zaxis.tex b/doc/tex/c_zaxis.tex
index 85a8570bb..94c8770f4 100644
--- a/doc/tex/c_zaxis.tex
+++ b/doc/tex/c_zaxis.tex
@@ -15,8 +15,8 @@ The function {\tt zaxisCreate} creates a vertical Z-axis.
\hspace*{4mm}\begin{minipage}[]{15cm}
\begin{deflist}{\tt zaxistype\ }
\item[{\tt zaxistype}]
-The type of the Z-axis, one of the set of predefined CDI Z-axis types.
- The valid CDI Z-axis types are {\tt ZAXIS\_GENERIC}, {\tt ZAXIS\_SURFACE},
+The type of the Z-axis, one of the set of predefined \CDI Z-axis types.
+ The valid \CDI Z-axis types are {\tt ZAXIS\_GENERIC}, {\tt ZAXIS\_SURFACE},
{\tt ZAXIS\_HYBRID}, {\tt ZAXIS\_PRESSURE}, {\tt ZAXIS\_HEIGHT},
{\tt ZAXIS\_DEPTH\_BELOW\_SEA} and {\tt ZAXIS\_DEPTH\_BELOW\_LAND}.
\item[{\tt size}]
@@ -90,8 +90,8 @@ Z-axis ID, from a previous call to {\htmlref{\tt zaxisCreate}{zaxisCreate}}
\subsubsection*{Result}
{\tt zaxisInqType} returns the type of the Z-axis,
-one of the set of predefined CDI Z-axis types.
-The valid CDI Z-axis types are {\tt ZAXIS\_GENERIC}, {\tt ZAXIS\_SURFACE},
+one of the set of predefined \CDI Z-axis types.
+The valid \CDI Z-axis types are {\tt ZAXIS\_GENERIC}, {\tt ZAXIS\_SURFACE},
{\tt ZAXIS\_HYBRID}, {\tt ZAXIS\_PRESSURE}, {\tt ZAXIS\_HEIGHT},
{\tt ZAXIS\_DEPTH\_BELOW\_SEA} and {\tt ZAXIS\_DEPTH\_BELOW\_LAND}.
diff --git a/doc/tex/dataset.tex b/doc/tex/dataset.tex
index 7cba8ecbe..fc5bfe057 100644
--- a/doc/tex/dataset.tex
+++ b/doc/tex/dataset.tex
@@ -1,6 +1,6 @@
This module contains functions to read and write the data.
To create a new dataset the output format must be specified
-with one of the following predefined file types:
+with one of the following predefined file format types:
\vspace*{3mm}
\hspace*{8mm}\begin{minipage}{15cm}
@@ -15,9 +15,11 @@ with one of the following predefined file types:
\end{minipage}
\vspace*{3mm}
+NetCDF is only available if the \CDI library was compiled with netCDF support!
+
To set the byte order of a binary dataset with the file format
type {\tt FILETYPE\_SRV}, {\tt FILETYPE\_EXT} or {\tt FILETYPE\_IEG} use one of the
-following constants in the call to {\htmlref{\tt streamDefByteorder}{streamDefByteorder}}:
+following predefined constants in the call to {\htmlref{\tt streamDefByteorder}{streamDefByteorder}}:
\vspace*{3mm}
\hspace*{8mm}\begin{minipage}{15cm}
diff --git a/doc/tex/f_examples.tex b/doc/tex/f_examples.tex
index abc805315..b7b187f46 100644
--- a/doc/tex/f_examples.tex
+++ b/doc/tex/f_examples.tex
@@ -1,12 +1,12 @@
\chapter{\label{example}Examples}
This appendix contains complete examples to write, read
-and copy a dataset with the CDI library.
+and copy a dataset with the \CDI library.
\section{\label{example_write}Write a dataset}
-Here is an example using CDI to write a netCDF dataset with
+Here is an example using \CDI to write a netCDF dataset with
2 variables on 3 time steps. The first variable is a 2D field
on surface level and the second variable is a 3D field on 5 pressure
levels. Both variables are on the same lon/lat grid.
diff --git a/doc/tex/f_grid.tex b/doc/tex/f_grid.tex
index 1ee99e628..d8b83e976 100644
--- a/doc/tex/f_grid.tex
+++ b/doc/tex/f_grid.tex
@@ -15,8 +15,8 @@ The function {\tt gridCreate} creates a horizontal Grid.
\hspace*{4mm}\begin{minipage}[]{15cm}
\begin{deflist}{\tt gridtype\ }
\item[{\tt gridtype}]
-The type of the grid, one of the set of predefined CDI grid types.
- The valid CDI grid types are {\tt GRID\_GENERIC}, {\tt GRID\_GAUSSIAN},
+The type of the grid, one of the set of predefined \CDI grid types.
+ The valid \CDI grid types are {\tt GRID\_GENERIC}, {\tt GRID\_GAUSSIAN},
{\tt GRID\_LONLAT}, {\tt GRID\_SPECTRAL}, {\tt GRID\_GME},
{\tt GRID\_CURVILINEAR} and {\tt GRID\_CELL}.
\item[{\tt size}]
@@ -88,7 +88,7 @@ The function {\tt gridDuplicate} duplicates a horizontal Grid.
\begin{deflist}{\tt gridID\ }
\item[{\tt gridID}]
Grid ID, from a previous call to {\htmlref{\tt gridCreate}{gridCreate}},
- {\tt gridDuplicate} or {\tt vlistInqVarGrid}.
+ {\htmlref{\tt gridDuplicate}{gridDuplicate}} or {\htmlref{\tt vlistInqVarGrid}{vlistInqVarGrid}}.
\end{deflist}
\end{minipage}
@@ -122,8 +122,8 @@ Grid ID, from a previous call to {\htmlref{\tt gridCreate}{gridCreate}}
\subsubsection*{Result}
{\tt gridInqType} returns the type of the grid,
-one of the set of predefined CDI grid types.
-The valid CDI grid types are {\tt GRID\_GENERIC}, {\tt GRID\_GAUSSIAN},
+one of the set of predefined \CDI grid types.
+The valid \CDI grid types are {\tt GRID\_GENERIC}, {\tt GRID\_GAUSSIAN},
{\tt GRID\_LONLAT}, {\tt GRID\_SPECTRAL}, {\tt GRID\_GME}, {\tt GRID\_CURVILINEAR}
and {\tt GRID\_CELL}.
diff --git a/doc/tex/f_link.tex b/doc/tex/f_link.tex
index f0e36e656..03540b7ce 100644
--- a/doc/tex/f_link.tex
+++ b/doc/tex/f_link.tex
@@ -1,4 +1,4 @@
-Every FORTRAN file that references CDI functions or constants must contain
+Every FORTRAN file that references \CDI functions or constants must contain
an appropriate {\tt INCLUDE} statement before the first such reference:
\begin{verbatim}
@@ -15,11 +15,11 @@ the compiler, to specify a directory where {\tt cdi.inc} is installed, for examp
Alternatively, you could specify an absolute path name in the {\tt INCLUDE}
statement, but then your program would not compile on another platform
-where CDI is installed in a different location.
+where \CDI is installed in a different location.
-Unless the CDI library is installed in a standard directory where the linker
+Unless the \CDI library is installed in a standard directory where the linker
always looks, you must use the {\tt -L} and {\tt -l} options to links an object file that
-uses the CDI library. For example:
+uses the \CDI library. For example:
\begin{verbatim}
f77 -o myprogram myprogram.o -L/usr/local/cdi/lib -lcdi
@@ -31,7 +31,7 @@ Alternatively, you could specify an absolute path name for the library:
f77 -o myprogram myprogram.o -L/usr/local/cdi/lib/libcdi
\end{verbatim}
-If the CDI library is using other external libraries, you must add this
+If the \CDI library is using other external libraries, you must add this
libraries in the same way.
For example with the netCDF library:
diff --git a/doc/tex/f_stream.tex b/doc/tex/f_stream.tex
index f56828596..f0a1825b9 100644
--- a/doc/tex/f_stream.tex
+++ b/doc/tex/f_stream.tex
@@ -16,8 +16,8 @@ The function {\tt streamOpenWrite} creates a new datset.
\item[{\tt path}]
The name of the new dataset
\item[{\tt filetype}]
-The type of the file format, one of the set of predefined CDI file format types.
- The valid CDI file format types are {\tt FILETYPE\_GRB}, {\tt FILETYPE\_NC},
+The type of the file format, one of the set of predefined \CDI file format types.
+ The valid \CDI file format types are {\tt FILETYPE\_GRB}, {\tt FILETYPE\_NC},
{\tt FILETYPE\_NC2}, {\tt FILETYPE\_SRV}, {\tt FILETYPE\_EXT} and {\tt FILETYPE\_IEG}.
\end{deflist}
@@ -167,8 +167,8 @@ Stream ID, from a previous call to {\htmlref{\tt streamOpenRead}{streamOpenRead}
\subsubsection*{Result}
{\tt streamInqFiletype} returns the type of the file format,
-one of the set of predefined CDI file format types.
-The valid CDI file format types are {\tt FILETYPE\_GRB}, {\tt FILETYPE\_NC},
+one of the set of predefined \CDI file format types.
+The valid \CDI file format types are {\tt FILETYPE\_GRB}, {\tt FILETYPE\_NC},
{\tt FILETYPE\_NC2}, {\tt FILETYPE\_SRV}, {\tt FILETYPE\_EXT} and {\tt FILETYPE\_IEG}.
@@ -191,7 +191,7 @@ with the file format type {\tt FILETYPE\_SRV}, {\tt FILETYPE\_EXT} or {\tt FILET
\item[{\tt streamID}]
Stream ID, from a previous call to {\htmlref{\tt streamOpenRead}{streamOpenRead}} or {\htmlref{\tt streamOpenWrite}{streamOpenWrite}}
\item[{\tt byteorder}]
-The byte order of a dataset, one of the CDI constants {\tt CDI\_BIGENDIAN} and
+The byte order of a dataset, one of the \CDI constants {\tt CDI\_BIGENDIAN} and
{\tt CDI\_LITTLEENDIAN}.
\end{deflist}
@@ -222,7 +222,7 @@ Stream ID, from a previous call to {\htmlref{\tt streamOpenRead}{streamOpenRead}
\subsubsection*{Result}
{\tt streamInqByteorder} returns the type of the byte order.
-The valid CDI byte order types are {\tt CDI\_BIGENDIAN} and {\tt CDI\_LITTLEENDIAN}
+The valid \CDI byte order types are {\tt CDI\_BIGENDIAN} and {\tt CDI\_LITTLEENDIAN}
diff --git a/doc/tex/f_taxis.tex b/doc/tex/f_taxis.tex
index eea2f0c56..faea16684 100644
--- a/doc/tex/f_taxis.tex
+++ b/doc/tex/f_taxis.tex
@@ -15,8 +15,8 @@ The function {\tt taxisCreate} creates a Time axis.
\hspace*{4mm}\begin{minipage}[]{15cm}
\begin{deflist}{\tt taxistype\ }
\item[{\tt taxistype}]
-The type of the Time axis, one of the set of predefined CDI time axis types.
- The valid CDI time axis types are {\tt TAXIS\_ABSOLUTE} and {\tt TAXIS\_RELATIVE}.
+The type of the Time axis, one of the set of predefined \CDI time axis types.
+ The valid \CDI time axis types are {\tt TAXIS\_ABSOLUTE} and {\tt TAXIS\_RELATIVE}.
\end{deflist}
\end{minipage}
@@ -78,7 +78,7 @@ The function {\tt taxisDefVdate} defines the reference date of a Time axis.
\hspace*{4mm}\begin{minipage}[]{15cm}
\begin{deflist}{\tt taxisID\ }
\item[{\tt taxisID}]
-Time axis ID, from a previous call to {\tt taxisCreate}
+Time axis ID, from a previous call to {\htmlref{\tt taxisCreate}{taxisCreate}}
\item[{\tt rdate}]
Reference date (YYYYMMDD)
@@ -101,7 +101,7 @@ The function {\tt taxisInqRdate} returns the reference date of a Time axis.
\hspace*{4mm}\begin{minipage}[]{15cm}
\begin{deflist}{\tt taxisID\ }
\item[{\tt taxisID}]
-Time axis ID, from a previous call to {\tt taxisCreate}
+Time axis ID, from a previous call to {\htmlref{\tt taxisCreate}{taxisCreate}}
\end{deflist}
\end{minipage}
@@ -127,7 +127,7 @@ The function {\tt taxisDefVdate} defines the reference time of a Time axis.
\hspace*{4mm}\begin{minipage}[]{15cm}
\begin{deflist}{\tt taxisID\ }
\item[{\tt taxisID}]
-Time axis ID, from a previous call to {\tt taxisCreate}
+Time axis ID, from a previous call to {\htmlref{\tt taxisCreate}{taxisCreate}}
\item[{\tt rtime}]
Reference time (HHMM)
@@ -150,7 +150,7 @@ The function {\tt taxisInqRtime} returns the reference time of a Time axis.
\hspace*{4mm}\begin{minipage}[]{15cm}
\begin{deflist}{\tt taxisID\ }
\item[{\tt taxisID}]
-Time axis ID, from a previous call to {\tt taxisCreate}
+Time axis ID, from a previous call to {\htmlref{\tt taxisCreate}{taxisCreate}}
\end{deflist}
\end{minipage}
@@ -176,7 +176,7 @@ The function {\tt taxisDefVdate} defines the verification date of a Time axis.
\hspace*{4mm}\begin{minipage}[]{15cm}
\begin{deflist}{\tt taxisID\ }
\item[{\tt taxisID}]
-Time axis ID, from a previous call to {\tt taxisCreate}
+Time axis ID, from a previous call to {\htmlref{\tt taxisCreate}{taxisCreate}}
\item[{\tt vdate}]
Verification date (YYYYMMDD)
@@ -199,7 +199,7 @@ The function {\tt taxisInqVdate} returns the verification date of a Time axis.
\hspace*{4mm}\begin{minipage}[]{15cm}
\begin{deflist}{\tt taxisID\ }
\item[{\tt taxisID}]
-Time axis ID, from a previous call to {\tt taxisCreate}
+Time axis ID, from a previous call to {\htmlref{\tt taxisCreate}{taxisCreate}}
\end{deflist}
\end{minipage}
@@ -225,7 +225,7 @@ The function {\tt taxisDefVtime} defines the verification time of a Time axis.
\hspace*{4mm}\begin{minipage}[]{15cm}
\begin{deflist}{\tt taxisID\ }
\item[{\tt taxisID}]
-Time axis ID, from a previous call to {\tt taxisCreate}
+Time axis ID, from a previous call to {\htmlref{\tt taxisCreate}{taxisCreate}}
\item[{\tt vtime}]
Verification time (HHMM)
@@ -248,7 +248,7 @@ The function {\tt taxisInqVtime} returns the verification time of a Time axis.
\hspace*{4mm}\begin{minipage}[]{15cm}
\begin{deflist}{\tt taxisID\ }
\item[{\tt taxisID}]
-Time axis ID, from a previous call to {\tt taxisCreate}
+Time axis ID, from a previous call to {\htmlref{\tt taxisCreate}{taxisCreate}}
\end{deflist}
\end{minipage}
@@ -274,10 +274,10 @@ The function {\tt taxisDefCalendar} defines the calendar of a Time axis.
\hspace*{4mm}\begin{minipage}[]{15cm}
\begin{deflist}{\tt calendar\ }
\item[{\tt taxisID}]
-Time axis ID, from a previous call to {\tt taxisCreate}
+Time axis ID, from a previous call to {\htmlref{\tt taxisCreate}{taxisCreate}}
\item[{\tt calendar}]
-The type of the calendar, one of the set of predefined CDI calendar types.
- The valid CDI calendar types are {\tt CALENDAR\_STANDARD}, {\tt CALENDAR\_360DAYS},
+The type of the calendar, one of the set of predefined \CDI calendar types.
+ The valid \CDI calendar types are {\tt CALENDAR\_STANDARD}, {\tt CALENDAR\_360DAYS},
{\tt CALENDAR\_365DAYS} and {\tt CALENDAR\_366DAYS}.
\end{deflist}
@@ -299,7 +299,7 @@ The function {\tt taxisInqCalendar} returns the calendar of a Time axis.
\hspace*{4mm}\begin{minipage}[]{15cm}
\begin{deflist}{\tt taxisID\ }
\item[{\tt taxisID}]
-Time axis ID, from a previous call to {\tt taxisCreate}
+Time axis ID, from a previous call to {\htmlref{\tt taxisCreate}{taxisCreate}}
\end{deflist}
\end{minipage}
@@ -307,7 +307,7 @@ Time axis ID, from a previous call to {\tt taxisCreate}
\subsubsection*{Result}
{\tt taxisInqCalendar} returns the type of the calendar,
-one of the set of predefined CDI calendar types.
-The valid CDI calendar types are {\tt CALENDAR\_STANDARD}, {\tt CALENDAR\_360DAYS},
+one of the set of predefined \CDI calendar types.
+The valid \CDI calendar types are {\tt CALENDAR\_STANDARD}, {\tt CALENDAR\_360DAYS},
{\tt CALENDAR\_365DAYS} and {\tt CALENDAR\_366DAYS}.
diff --git a/doc/tex/f_vlist.tex b/doc/tex/f_vlist.tex
index be4e653f3..7fe653b40 100644
--- a/doc/tex/f_vlist.tex
+++ b/doc/tex/f_vlist.tex
@@ -238,7 +238,7 @@ The function {\tt vlistDefTaxis} defines the time axis of a variable list.
\item[{\tt vlistID}]
Variable list ID, from a previous call to {\htmlref{\tt vlistCreate}{vlistCreate}}
\item[{\tt taxisID}]
-Time axis ID, from a previous call to {\tt taxisCreate}
+Time axis ID, from a previous call to {\htmlref{\tt taxisCreate}{taxisCreate}}
\end{deflist}
\end{minipage}
diff --git a/doc/tex/f_vlist_var.tex b/doc/tex/f_vlist_var.tex
index 05180ea1f..a80efc7b7 100644
--- a/doc/tex/f_vlist_var.tex
+++ b/doc/tex/f_vlist_var.tex
@@ -22,8 +22,8 @@ Grid ID, from a previous call to {\htmlref{\tt gridCreate}{gridCreate}}
\item[{\tt zaxisID}]
Z-axis ID, from a previous call to {\htmlref{\tt zaxisCreate}{zaxisCreate}}
\item[{\tt timeID}]
-One of the set of predefined CDI time identifiers.
- The valid CDI time identifiers are {\tt TIME\_CONSTANT} and {\tt TIME\_VARIABLE}.
+One of the set of predefined \CDI time identifiers.
+ The valid \CDI time identifiers are {\tt TIME\_CONSTANT} and {\tt TIME\_VARIABLE}.
\end{deflist}
\end{minipage}
@@ -294,7 +294,7 @@ Variable list ID, from a previous call to {\htmlref{\tt vlistCreate}{vlistCreate
Variable identifier
\item[{\tt datatype}]
The data type identifier.
- The valid CDI data types are {\tt DATATYPE\_PACK1}, {\tt DATATYPE\_PACK2},
+ The valid \CDI data types are {\tt DATATYPE\_PACK1}, {\tt DATATYPE\_PACK2},
{\tt DATATYPE\_PACK3}, {\tt DATATYPE\_REAL4} and {\tt DATATYPE\_REAL8}.
@@ -327,7 +327,7 @@ Variable identifier
\subsubsection*{Result}
{\tt vlistInqVarDatatype} returns an identifier to the data type of the variable.
-The valid CDI data types are {\tt DATATYPE\_PACK1}, {\tt DATATYPE\_PACK2}, {\tt DATATYPE\_PACK3},
+The valid \CDI data types are {\tt DATATYPE\_PACK1}, {\tt DATATYPE\_PACK2}, {\tt DATATYPE\_PACK3},
{\tt DATATYPE\_REAL4} and {\tt DATATYPE\_REAL8}.
diff --git a/doc/tex/f_zaxis.tex b/doc/tex/f_zaxis.tex
index 3d801efd5..7097b358e 100644
--- a/doc/tex/f_zaxis.tex
+++ b/doc/tex/f_zaxis.tex
@@ -15,8 +15,8 @@ The function {\tt zaxisCreate} creates a vertical Z-axis.
\hspace*{4mm}\begin{minipage}[]{15cm}
\begin{deflist}{\tt zaxistype\ }
\item[{\tt zaxistype}]
-The type of the Z-axis, one of the set of predefined CDI Z-axis types.
- The valid CDI Z-axis types are {\tt ZAXIS\_GENERIC}, {\tt ZAXIS\_SURFACE},
+The type of the Z-axis, one of the set of predefined \CDI Z-axis types.
+ The valid \CDI Z-axis types are {\tt ZAXIS\_GENERIC}, {\tt ZAXIS\_SURFACE},
{\tt ZAXIS\_HYBRID}, {\tt ZAXIS\_PRESSURE}, {\tt ZAXIS\_HEIGHT},
{\tt ZAXIS\_DEPTH\_BELOW\_SEA} and {\tt ZAXIS\_DEPTH\_BELOW\_LAND}.
\item[{\tt size}]
@@ -90,8 +90,8 @@ Z-axis ID, from a previous call to {\htmlref{\tt zaxisCreate}{zaxisCreate}}
\subsubsection*{Result}
{\tt zaxisInqType} returns the type of the Z-axis,
-one of the set of predefined CDI Z-axis types.
-The valid CDI Z-axis types are {\tt ZAXIS\_GENERIC}, {\tt ZAXIS\_SURFACE},
+one of the set of predefined \CDI Z-axis types.
+The valid \CDI Z-axis types are {\tt ZAXIS\_GENERIC}, {\tt ZAXIS\_SURFACE},
{\tt ZAXIS\_HYBRID}, {\tt ZAXIS\_PRESSURE}, {\tt ZAXIS\_HEIGHT},
{\tt ZAXIS\_DEPTH\_BELOW\_SEA} and {\tt ZAXIS\_DEPTH\_BELOW\_LAND}.
diff --git a/doc/tex/formats.tex b/doc/tex/formats.tex
index 0b465fab2..4e93ff12f 100644
--- a/doc/tex/formats.tex
+++ b/doc/tex/formats.tex
@@ -12,12 +12,12 @@ The netCDF library also defines a machine-independent format for
representing scientific data. Together, the interface, library, and
format support the creation, access, and sharing of scientific data.
-CDI supports only 2D, 3D and 4D arrays and the attributes must follow the
+\CDI supports only 2D, 3D and 4D arrays and the attributes must follow the
\href{http://ftp.unidata.ucar.edu/software/netcdf/docs/conventions.html}
{GDT, COARDS or CF Conventions}.
-NetCDF is an external library and not part of CDI. To use netCDF with
-CDI the netCDF library must be installed before the configuration
-of the CDI library (see \htmlref{Build}{build}).
+NetCDF is an external library and not part of \CDI. To use netCDF with
+\CDI the netCDF library must be installed before the configuration
+of the \CDI library (see \htmlref{Build}{build}).
\subsection{ncdap}
@@ -54,8 +54,8 @@ The meaning of the variables are:
\item[{\tt itime}] The time as HHMM
\item[{\tt nlon}] The number of longitudes
\item[{\tt nlat}] The number of latitides
-\item[{\tt idispo1}] For the users disposal (Not used in CDI)
-\item[{\tt idispo2}] For the users disposal (Not used in CDI)
+\item[{\tt idispo1}] For the users disposal (Not used in \CDI)
+\item[{\tt idispo2}] For the users disposal (Not used in \CDI)
\end{deflist}
\end{minipage}
@@ -101,4 +101,9 @@ description section are coded with 4 byte integer values and the
data section can have 4 or 8 byte IEEE floating point values.
The header and the data section have the standard Fortran blocking
for binary data records.
-CDI supports only data on an rotated grid for the IEG format.
+\CDI supports only data on an rotated grid for the IEG format.
+
+%%% Local Variables:
+%%% mode: latex
+%%% TeX-master: t
+%%% End:
diff --git a/doc/tex/install.tex b/doc/tex/install.tex
index 0c61b1a81..7541e3567 100644
--- a/doc/tex/install.tex
+++ b/doc/tex/install.tex
@@ -4,10 +4,8 @@ This section describes how to build the \CDI library from the sources on a UNIX
\CDI is using the GNU configure and build system to compile the source code.
The only requirement is a working ANSI C compiler.
-%First go to the \href{http://www.mpimet.mpg.de/~cdo/download.html}{\tt download} page
-%({\tt http://www.mpimet.mpg.de/\~\,cdo/download.html}) to get the latest distribution,
-First go to the \href{http://www.mpimet.mpg.de/sw/cdi}{\tt download} page
-({\tt http://www.mpimet.mpg.de/sw/cdi}) to get the latest distribution,
+First go to the \href{http://www.mpimet.mpg.de/cdi}{\tt download} page
+({\tt http://www.mpimet.mpg.de/cdi}) to get the latest distribution,
if you did not have it already.
To take full advantage of \CDI's features the following additional
@@ -20,13 +18,6 @@ library should be installed.
This is needed to read/write netCDF files with \CDI.
\end{itemize}
-%This section is divided into the following sections:
-%<ul>
-%<li>\ref install_src_unix "Compiling from source on Unix"
-%<li>\ref install_bin_unix "Installing the binaries on Unix"
-%<li>\ref build_tools "Tools used to develop CDO"
-%</ul>
-
\subsection{Compilation}
@@ -87,3 +78,8 @@ the {\tt --prefix} option of the configure script.
%Alternatively, you can also copy the library from the {\tt src} directory
%manually to some {\tt lib} directory in your search path.
+
+%%% Local Variables:
+%%% mode: latex
+%%% TeX-master: "usage"
+%%% End:
diff --git a/doc/tex/makedoc b/doc/tex/makedoc
index 34ab12f8c..29ef8a90a 100755
--- a/doc/tex/makedoc
+++ b/doc/tex/makedoc
@@ -403,6 +403,7 @@ sub printcfdoc {
if ( $#list >= 0 ) {
foreach $tag (@list) {
chomp $tag;
+ $tag =~ s/ CDI / \\CDI /og;
$tag =~ s/_/\\_/og;
$tag =~ s/\@fref\{([^}]*)\}/{\\htmlref{\\tt \1}{\1}}/og;
$tag =~ s/\@func\{([^}]*)\}/{\\tt \1}/og;
diff --git a/doc/tex/modules.tex b/doc/tex/modules.tex
index 0eb7705ce..c15775f24 100644
--- a/doc/tex/modules.tex
+++ b/doc/tex/modules.tex
@@ -1,2 +1,2 @@
-Complete examples for write, read and copy a dataset with CDI
+Complete examples for write, read and copy a dataset with \CDI
can be found in \htmlref{Appendix B}{example}.
diff --git a/doc/tex/taxis.tex b/doc/tex/taxis.tex
index 50c26aee8..ca111801a 100644
--- a/doc/tex/taxis.tex
+++ b/doc/tex/taxis.tex
@@ -1,6 +1,7 @@
This section contains functions to define a new Time axis
and to get information from an existing T-axis.
-A T-axis object is necessary to define the time axis of a dataset.
+A T-axis object is necessary to define the time axis of a dataset
+and must be assiged to a variable list using \htmlref{\tt vlistDefTaxis}{vlistDefTaxis}.
The following different Time axis types are available:
\vspace*{3mm}
diff --git a/doc/tex/usage.tex b/doc/tex/usage.tex
index f6fdcc3fc..b52770160 100644
--- a/doc/tex/usage.tex
+++ b/doc/tex/usage.tex
@@ -1,6 +1,6 @@
\section{Creating a dataset}
-Here is a typical sequence of CDI calls used to create a new dataset:
+Here is a typical sequence of \CDI calls used to create a new dataset:
\begin{lstlisting}[backgroundcolor=\color{zebg}, basicstyle=\footnotesize]
gridCreate ! create a horizontal Grid: from type and size
@@ -56,9 +56,14 @@ Here is a typical sequence of CDI calls used to create a new dataset:
\section{Compiling and Linking with the CDI library}
-Details of how to compile and link a program that uses the CDI C or FORTRAN
+Details of how to compile and link a program that uses the \CDI C or FORTRAN
interfaces differ, depending on the operating system, the available compilers,
-and where the CDI library and include files are installed.
-Here are examples of how to compile and link a program that uses the CDI library
+and where the \CDI library and include files are installed.
+Here are examples of how to compile and link a program that uses the \CDI library
on a Unix platform, so that you can adjust these examples to fit your installation.
+
+%%% Local Variables:
+%%% mode: latex
+%%% TeX-master: t
+%%% End:
diff --git a/doc/tex/variable.tex b/doc/tex/variable.tex
index 31afb84fa..56fab2b51 100644
--- a/doc/tex/variable.tex
+++ b/doc/tex/variable.tex
@@ -12,6 +12,9 @@ one of the following time types must be specified:
\end{minipage}
\vspace*{3mm}
+The default data type is 2 byte for GRIB and 4 byte for all other
+file format types. To change the data type use one of the following
+predefined constants:
\vspace*{3mm}
\hspace*{8mm}\begin{minipage}{15cm}
diff --git a/src/grid.c b/src/grid.c
index 194f90376..fdacdcb86 100644
--- a/src/grid.c
+++ b/src/grid.c
@@ -2336,7 +2336,7 @@ int gridGenerate(GRID grid)
@Prototype int gridDuplicate(int gridID)
@Parameter
@Item gridID Grid ID, from a previous call to @fref{gridCreate},
- @func{gridDuplicate} or @func{vlistInqVarGrid}.
+ @fref{gridDuplicate} or @fref{vlistInqVarGrid}.
@Description
The function @func{gridDuplicate} duplicates a horizontal Grid.
diff --git a/src/taxis.c b/src/taxis.c
index ee12d881e..9642d89af 100644
--- a/src/taxis.c
+++ b/src/taxis.c
@@ -274,7 +274,7 @@ void taxisDefType(int taxisID, int type)
@Prototype void taxisDefVdate(int taxisID, int vdate)
@Parameter
- @Item taxisID Time axis ID, from a previous call to @func{taxisCreate}
+ @Item taxisID Time axis ID, from a previous call to @fref{taxisCreate}
@Item vdate Verification date (YYYYMMDD)
@Description
@@ -298,7 +298,7 @@ void taxisDefVdate(int taxisID, int vdate)
@Prototype void taxisDefVtime(int taxisID, int vtime)
@Parameter
- @Item taxisID Time axis ID, from a previous call to @func{taxisCreate}
+ @Item taxisID Time axis ID, from a previous call to @fref{taxisCreate}
@Item vtime Verification time (HHMM)
@Description
@@ -322,7 +322,7 @@ void taxisDefVtime(int taxisID, int vtime)
@Prototype void taxisDefRdate(int taxisID, int rdate)
@Parameter
- @Item taxisID Time axis ID, from a previous call to @func{taxisCreate}
+ @Item taxisID Time axis ID, from a previous call to @fref{taxisCreate}
@Item rdate Reference date (YYYYMMDD)
@Description
@@ -346,7 +346,7 @@ void taxisDefRdate(int taxisID, int rdate)
@Prototype void taxisDefRtime(int taxisID, int rtime)
@Parameter
- @Item taxisID Time axis ID, from a previous call to @func{taxisCreate}
+ @Item taxisID Time axis ID, from a previous call to @fref{taxisCreate}
@Item rtime Reference time (HHMM)
@Description
@@ -370,7 +370,7 @@ void taxisDefRtime(int taxisID, int rtime)
@Prototype void taxisDefCalendar(int taxisID, int calendar)
@Parameter
- @Item taxisID Time axis ID, from a previous call to @func{taxisCreate}
+ @Item taxisID Time axis ID, from a previous call to @fref{taxisCreate}
@Item calendar The type of the calendar, one of the set of predefined CDI calendar types.
The valid CDI calendar types are @func{CALENDAR_STANDARD}, @func{CALENDAR_360DAYS},
@func{CALENDAR_365DAYS} and @func{CALENDAR_366DAYS}.
@@ -449,7 +449,7 @@ void taxisCopyTimestep(int taxisIDdes, int taxisIDsrc)
@Prototype int taxisInqVdate(int taxisID)
@Parameter
- @Item taxisID Time axis ID, from a previous call to @func{taxisCreate}
+ @Item taxisID Time axis ID, from a previous call to @fref{taxisCreate}
@Description
The function @func{taxisInqVdate} returns the verification date of a Time axis.
@@ -475,7 +475,7 @@ int taxisInqVdate(int taxisID)
@Prototype int taxisInqVtime(int taxisID)
@Parameter
- @Item taxisID Time axis ID, from a previous call to @func{taxisCreate}
+ @Item taxisID Time axis ID, from a previous call to @fref{taxisCreate}
@Description
The function @func{taxisInqVtime} returns the verification time of a Time axis.
@@ -501,7 +501,7 @@ int taxisInqVtime(int taxisID)
@Prototype int taxisInqRdate(int taxisID)
@Parameter
- @Item taxisID Time axis ID, from a previous call to @func{taxisCreate}
+ @Item taxisID Time axis ID, from a previous call to @fref{taxisCreate}
@Description
The function @func{taxisInqRdate} returns the reference date of a Time axis.
@@ -533,7 +533,7 @@ int taxisInqRdate(int taxisID)
@Prototype int taxisInqRtime(int taxisID)
@Parameter
- @Item taxisID Time axis ID, from a previous call to @func{taxisCreate}
+ @Item taxisID Time axis ID, from a previous call to @fref{taxisCreate}
@Description
The function @func{taxisInqRtime} returns the reference time of a Time axis.
@@ -565,7 +565,7 @@ int taxisInqRtime(int taxisID)
@Prototype int taxisInqCalendar(int taxisID)
@Parameter
- @Item taxisID Time axis ID, from a previous call to @func{taxisCreate}
+ @Item taxisID Time axis ID, from a previous call to @fref{taxisCreate}
@Description
The function @func{taxisInqCalendar} returns the calendar of a Time axis.
diff --git a/src/vlist.c b/src/vlist.c
index 75bbe4083..ff7e7ba97 100644
--- a/src/vlist.c
+++ b/src/vlist.c
@@ -1149,7 +1149,7 @@ void vlistPrint(int vlistID)
@Prototype void vlistDefTaxis(int vlistID, int taxisID)
@Parameter
@Item vlistID Variable list ID, from a previous call to @fref{vlistCreate}
- @Item taxisID Time axis ID, from a previous call to @func{taxisCreate}
+ @Item taxisID Time axis ID, from a previous call to @fref{taxisCreate}
@Description
The function @func{vlistDefTaxis} defines the time axis of a variable list.
--
GitLab