Skip to content

Commit

Permalink
more C API documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
edhartnett committed May 22, 2019
1 parent 828cc91 commit d28b7aa
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 10 deletions.
17 changes: 8 additions & 9 deletions doc/source/c_api.txt
Original file line number Diff line number Diff line change
Expand Up @@ -15,15 +15,14 @@
\section readwrite_c Reading and Writing Distributed Arrays
- \ref PIO_read_darray_c
- \ref PIO_write_darray_c
\section utility_c Utility routines
- \ref PIO_set_hint_grp
- \ref PIO_setframe
- \ref PIO_advanceframe
- \ref PIO_setdebuglevel
- \ref PIO_seterrorhandling
- \ref PIO_get_local_array_size
- \ref PIO_getnumiotasks
- \ref PIO_set_blocksize
- \ref PIO_setframe_c
\section utility_c Utility
- \ref PIO_set_hint_grp_c
- \ref PIO_setdebuglevel_c
- \ref PIO_seterrorhandling_c
- \ref PIO_get_local_array_size_c
- \ref PIO_getnumiotasks_c
- \ref PIO_set_blocksize_c
\section netcdf_c NetCDF format specific routines
Also see: http://www.unidata.ucar.edu/software/netcdf/docs/
\subsection putget_c Reading/Writing netcdf metadata
Expand Down
4 changes: 3 additions & 1 deletion src/clib/pioc.c
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@
* @defgroup PIO_finalize_c Shut Down the IO System
* @defgroup PIO_initdecomp_c Initialize a Decomposition
* @defgroup PIO_freedecomp_c Free a Decomposition
* @defgroup PIO_setframe_c Set the Record Number
*/

/** The default error handler used when iosystem cannot be located. */
Expand Down Expand Up @@ -126,6 +127,7 @@ PIOc_Set_File_Error_Handling(int ncid, int method)
* @param ncid the ncid of the open file
* @param varid the variable ID
* @returns 0 on success, error code otherwise
* @ingroup PIO_setframe_c
* @author Jim Edwards, Ed Hartnett
*/
int
Expand Down Expand Up @@ -186,7 +188,7 @@ PIOc_advanceframe(int ncid, int varid)
* @param frame the value of the unlimited dimension. In c 0 for the
* first record, 1 for the second
* @return PIO_NOERR for no error, or error code.
* @ingroup PIO_setframe
* @ingroup PIO_setframe_c
* @author Jim Edwards, Ed Hartnett
*/
int
Expand Down

0 comments on commit d28b7aa

Please sign in to comment.