Merge pull request ESMCI#1460 from NCAR/ejh_more_docs_3

More fortran documentation changes

src/clib/pio_darray.c

@@ -14,10 +14,12 @@
 #include <uthash.h>
 
 /**
- * @defgroup PIO_read_darray_c Reading Distributes Arrays
+ * @defgroup PIO_read_darray_c Reading Distributes Arrays in C
  * Read data from a netCDF file to a distributed array with the C API.
- * @defgroup PIO_write_darray_c Writing Distributes Arrays
- * Write data from a distributed array to a netCDF file with the C API.
+ *
+ * @defgroup PIO_write_darray_c Writing Distributes Arrays in C
+ * Write data from a distributed array to a netCDF file with the C
+ * API.
  */
 
 /** 10MB default limit. */

src/clib/pio_file.c

@@ -8,14 +8,18 @@
 #include <uthash.h>
 
 /**
- * @defgroup PIO_open_file_c Open a File
+ * @defgroup PIO_open_file_c Open a File in C
  * Open an existing netCDF file with PIO with the C API.
- * @defgroup PIO_create_file_c Create a File
+ *
+ * @defgroup PIO_create_file_c Create a File in C
  * Create a new netCDF file with PIO with the C API.
- * @defgroup PIO_sync_file_c Sync a File
+ *
+ * @defgroup PIO_sync_file_c Sync a File in C
  * Flush buffers and sync data to disk with the C API.
- * @defgroup PIO_close_file_c Close a File
+ *
+ * @defgroup PIO_close_file_c Close a File in C
  * Close a file with the C API.
+ *
  */
 
 /* This is the next ncid that will be used when a file is opened or

src/clib/pio_nc.c

@@ -19,36 +19,50 @@
 #include <pio_internal.h>
 
 /**
- * @defgroup PIO_inq_c Learn About File
+ * @defgroup PIO_inq_c Learn About File in C
  * Learn the number of variables, dimensions, and global atts, and the
  * unlimited dimension.
- * @defgroup PIO_typelen_c Learn Aboue a Data Type
+ *
+ * @defgroup PIO_typelen_c Learn Aboue a Data Type in C
  * Learn the length of a data type.
- * @defgroup PIO_inq_format_c Learn About Binary Format
+ *
+ * @defgroup PIO_inq_format_c Learn About Binary Format in C
  * Learn about the binary format.
- * @defgroup PIO_inq_dim_c Learn About a Dimension
+ *
+ * @defgroup PIO_inq_dim_c Learn About a Dimension in C
  * Learn dimension name and length.
- * @defgroup PIO_inq_var_c Learn About a Variable
+ *
+ * @defgroup PIO_inq_var_c Learn About a Variable in C
  * Learn variable name, dimensions, and type.
- * @defgroup PIO_inq_att_c Learn About an Attribute
+ *
+ * @defgroup PIO_inq_att_c Learn About an Attribute in C
  * Learn length, type, and name of an attribute.
- * @defgroup PIO_rename_dim_c Rename a Dimension
+ *
+ * @defgroup PIO_rename_dim_c Rename a Dimension in C
  * Rename a dimension.
- * @defgroup PIO_rename_var_c Rename a Variable
+ *
+ * @defgroup PIO_rename_var_c Rename a Variable in C
  * Rename a variable.
- * @defgroup PIO_rename_att_c Rename an Attribute
+ *
+ * @defgroup PIO_rename_att_c Rename an Attribute in C
  * Rename an attribute.
- * @defgroup PIO_del_att_c Delete an Attribute
+ *
+ * @defgroup PIO_del_att_c Delete an Attribute in C
  * Delete an attribute.
- * @defgroup PIO_set_fill_c Set Fill Value
+ *
+ * @defgroup PIO_set_fill_c Set Fill Value in C
  * Set the fill value for a variable.
- * @defgroup PIO_enddef_c End Define Mode
+ *
+ * @defgroup PIO_enddef_c End Define Mode in C
  * End define mode.
- * @defgroup PIO_redef_c Re-enter Define Mode
+ *
+ * @defgroup PIO_redef_c Re-enter Define Mode in C
  * Re-enter Define Mode.
- * @defgroup PIO_def_dim_c Define a Dimension
+ *
+ * @defgroup PIO_def_dim_c Define a Dimension in C
  * Define a new dimension in the file.
- * @defgroup PIO_def_var_c Define a Variable
+ *
+ * @defgroup PIO_def_var_c Define a Variable in C
  * Define a new variable in the file.
  */
 

src/clib/pioc.c

@@ -12,27 +12,38 @@
 
 /**
  * @defgroup PIO_init_c Initialize the IO System
- * Initialize the IOSystem, including specifying number of IO and computation tasks.
- * @defgroup PIO_finalize_c Shut Down the IO System
+ * Initialize the IOSystem, including specifying number of IO and
+ * computation tasks.
+ *
+ * @defgroup PIO_finalize_c Shut Down the IO System in C
  * Shut down an IOSystem, freeing all associated resources.
+ *
  * @defgroup PIO_initdecomp_c Initialize a Decomposition
  * Intiailize a decomposition of data into distributed arrays.
- * @defgroup PIO_freedecomp_c Free a Decomposition
+ *
+ * @defgroup PIO_freedecomp_c Free a Decomposition in C
  * Free a decomposition, and associated resources.
- * @defgroup PIO_setframe_c Set the Record Number
+ *
+ * @defgroup PIO_setframe_c Set the Record Number in C
  * Set the record number for a future call to PIOc_write_darray() or
  * PIOc_read_darray().
- * @defgroup PIO_set_hint_c Set a Hint
+ *
+ * @defgroup PIO_set_hint_c Set a Hint in C
  * Set an MPI Hint.
- * @defgroup PIO_error_method_c Set Error Handling
+ *
+ * @defgroup PIO_error_method_c Set Error Handling in C
  * Set the error handling method in case error is encountered.
- * @defgroup PIO_get_local_array_size_c Get the Local Size
+ *
+ * @defgroup PIO_get_local_array_size_c Get the Local Size in C
  * Get the local size of a distributed array.
- * @defgroup PIO_iosystem_is_active_c Check IOSystem
+ *
+ * @defgroup PIO_iosystem_is_active_c Check IOSystem in C
  * Is the IO system active?
- * @defgroup PIO_getnumiotasks_c Get Number IO Tasks
+ *
+ * @defgroup PIO_getnumiotasks_c Get Number IO Tasks in C
  * Get the Number of IO Tasks.
- * @defgroup PIO_set_blocksize_c Set Blocksize
+ *
+ * @defgroup PIO_set_blocksize_c Set Blocksize in C
  * Set the Blocksize.
  */