more documentation for netcdf integration

configure.ac

@@ -161,9 +161,9 @@ if test "x$enable_docs" = xyes; then
    fi
    AC_SUBST([FORTRAN_SRC_FILES], ["../src/flib/piodarray.f90  ../src/flib/pio.F90  ../src/flib/pio_kinds.F90  ../src/flib/piolib_mod.f90  ../src/flib/pionfatt_mod_2.f90  ../src/flib/pio_nf.F90  ../src/flib/pionfget_mod_2.f90  ../src/flib/pionfput_mod.f90  ../src/flib/pio_support.F90  ../src/flib/pio_types.F90"])
    if test "x$enable_developer_docs" = xyes; then
-      AC_SUBST([C_SRC_FILES], ["../src/clib"])
+      AC_SUBST([C_SRC_FILES], ["../src/clib ../src/ncint"])
    else
-      AC_SUBST([C_SRC_FILES], ["../src/clib/pio_nc.c ../src/clib/pio_nc4.c ../src/clib/pio_darray.c ../src/clib/pio_get_nc.c ../src/clib/pio_put_nc.c ../src/clib/pioc_support.c ../src/clib/pioc.c ../src/clib/pio_file.c ../src/clib/pio.h ../src/clib/pio_get_vard.c ../src/clib/pio_put_vard.c"])
+      AC_SUBST([C_SRC_FILES], ["../src/clib/pio_nc.c ../src/clib/pio_nc4.c ../src/clib/pio_darray.c ../src/clib/pio_get_nc.c ../src/clib/pio_put_nc.c ../src/clib/pioc_support.c ../src/clib/pioc.c ../src/clib/pio_file.c ../src/clib/pio.h ../src/clib/pio_get_vard.c ../src/clib/pio_put_vard.c ../src/ncint/ncint_pio.c ../src/ncint/nc_put_vard.c ../src/ncint/nc_get_vard.c"])
    fi
    AC_CONFIG_FILES([doc/Doxyfile])
 fi

src/clib/pio_file.c

@@ -179,9 +179,10 @@ PIOc_createfile(int iosysid, int *ncidp, int *iotype, const char *filename,
  * parameters are read on comp task 0 and ignored elsewhere.
  *
  * @param iosysid : A defined pio system descriptor (input)
+ * @param path : The filename to create.
  * @param cmode : The netcdf mode for the create operation.
- * @param filename : The filename to open
  * @param ncidp : A pio file descriptor (output)
+ *
  * @return 0 for success, error code otherwise.
  * @ingroup PIO_create_file_c
  * @author Ed Hartnett

src/clib/pioc_support.c

@@ -1936,7 +1936,7 @@ PIOc_writemap_from_f90(const char *file, int ndims, const int *gdims,
  * PIO_IOTYPE_NETCDF4P.
  * @param filename The filename to create.
  * @param mode The netcdf mode for the create operation.
- * @paran use_ext_ncid non-zero to use an externally assigned ncid
+ * @param use_ext_ncid non-zero to use an externally assigned ncid
  * (used in the netcdf integration layer).
  *
  * @returns 0 for success, error code otherwise.
@@ -2422,7 +2422,7 @@ find_iotype_from_omode(int mode, int *iotype)
 /**
  * Find the appropriate IOTYPE from mode flags to nc_create().
  *
- * @param mode the mode flag from nc_create().
+ * @param cmode the mode flag from nc_create().
  * @param iotype pointer that gets the IOTYPE.
  *
  * @return 0 on success, error code otherwise.
@@ -2473,7 +2473,7 @@ find_iotype_from_cmode(int cmode, int *iotype)
  * @param mode the netcdf mode for the open operation
  * @param retry non-zero to automatically retry with netCDF serial
  * classic.
- * @paran use_ext_ncid non-zero to use an externally assigned ncid
+ * @param use_ext_ncid non-zero to use an externally assigned ncid
  * (used in the netcdf integration layer).
  *
  * @return 0 for success, error code otherwise.

src/flib/Makefile.am

@@ -99,7 +99,7 @@ pionfput_mod.f90 pionfatt_mod_2.f90 pionfget_mod_2.f90
 piodarray.f90: piodarray.F90
 	$(CC) -E $< > $@
 piolib_mod.f90: piolib_mod.F90
-	$(CC) -E $< > $@
+	$(CC) -I../.. $(AM_CPPFLAGS) -E $< > $@
 pionfatt_mod.f90: pionfatt_mod.F90
 	$(CC) -E $< > $@
 pionfget_mod.f90: pionfget_mod.F90

src/ncint/ncint_pio.c

@@ -10,10 +10,11 @@
 #include <pio_internal.h>
 #include "ncintdispatch.h"
 
-/* The default io system id. */
+/** This is te default io system id. */
 extern int diosysid;
 
-/* Have we initialized? */
+/** Have we initialized the netCDF integration layer? This is where we
+ * register our dispatch layer with netcdf-c. */
 extern int ncint_initialized;
 
 /**

src/ncint/ncintdispatch.h

@@ -1,6 +1,7 @@
 /**
- * @file @internal This header file contains the prototypes for the
- * PIO netCDF integration layer.
+ * @file
+ * This header file contains the prototypes for the PIO netCDF
+ * integration layer.
  *
  * Ed Hartnett
  */
@@ -12,26 +13,6 @@
 #include <nc4dispatch.h>
 #include <netcdf_dispatch.h>
 
-/** This is the max size of an SD dataset name in HDF4 (from HDF4
- * documentation).*/
-#define NC_MAX_HDF4_NAME 64
-
-/** This is the max number of dimensions for a HDF4 SD dataset (from
- * HDF4 documentation). */
-#define NC_MAX_HDF4_DIMS 32
-
-/* Stuff below is for hdf4 files. */
-typedef struct NC_VAR_HDF4_INFO
-{
-    int sdsid;
-    int hdf4_data_type;
-} NC_VAR_HDF4_INFO_T;
-
-typedef struct NC_HDF4_FILE_INFO
-{
-    int sdid;
-} NC_HDF4_FILE_INFO_T;
-
 #if defined(__cplusplus)
 extern "C" {
 #endif