Skip to content

Commit

Permalink
starting separate manual for C/Fortran
Browse files Browse the repository at this point in the history
  • Loading branch information
edhartnett committed May 22, 2019
1 parent e2a58a2 commit df2524b
Show file tree
Hide file tree
Showing 6 changed files with 77 additions and 4 deletions.
1 change: 1 addition & 0 deletions configure.ac
Original file line number Diff line number Diff line change
Expand Up @@ -254,6 +254,7 @@ AC_OUTPUT(Makefile
tests/general/util/Makefile
tests/performance/Makefile
doc/Makefile
doc/source/Makefile
examples/Makefile
examples/c/Makefile
scripts/Makefile)
8 changes: 5 additions & 3 deletions doc/Makefile.am
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,15 @@

# Ed Hartnett 4/1/19

EXTRA_DIST = CMakeLists.txt customdoxygen.css Doxyfile.in \
DoxygenLayout.xml doxygen.sty

# Run doxygen, then confirm warning log file is empty.
check: all
all:
doxygen Doxyfile
[ ! -s doxywarn.log ]

SUBDIRS = source

CLEANFILES = *.log

EXTRA_DIST = CMakeLists.txt customdoxygen.css Doxyfile.in \
DoxygenLayout.xml doxygen.sty
8 changes: 8 additions & 0 deletions doc/source/Makefile.am
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# This is part of PIO. It creates the doc/source Makefile.

# Ed Hartnett 5/20/19

EXTRA_DIST = api.txt CAMexample.txt c_api.txt~ Decomp.txt example \
faq.txt Installing.txt Testing.txt base.txt c_api.txt \
contributing_code.txt Error.txt Examples.txt GettingStarted.txt \
mach_walkthrough.txt testpio_example.txt
2 changes: 1 addition & 1 deletion doc/source/api.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
/*! \page api PIO user interface
/*! \page api PIO Fortran Interface
This is a list of all user interface routines:

\section api_fileops PIO file Operations
Expand Down
1 change: 1 addition & 0 deletions doc/source/base.txt
Original file line number Diff line number Diff line change
Expand Up @@ -50,5 +50,6 @@ releases.
- \ref examp
- \ref faq
- \ref api
- \ref c_api
- \ref contributing_code
*/
61 changes: 61 additions & 0 deletions doc/source/c_api.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
/*! \page api PIO C Interface
This is a list of all user interface routines:

\section api_fileops PIO file Operations
- \ref PIO_openfile
- \ref PIO_createfile
- \ref PIO_syncfile
- \ref PIO_closefile
\section api_system PIO startup and shutdown routines
- \ref PIO_init
- \ref PIO_finalize
\section api_decomp PIO decomposition routines
- \ref PIO_initdecomp
- \ref PIO_freedecomp
\section readwrite Reading and Writing distributed variables
- \ref PIO_read_darray
- \ref PIO_write_darray
\section utility 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
\section netcdf NetCDF format specific routines
Also see: http://www.unidata.ucar.edu/software/netcdf/docs/
\subsection putget Reading/Writing netcdf metadata
- \ref PIO_get_att
- \ref PIO_put_att
- \ref PIO_get_var
- \ref PIO_put_var
\subsection utilnc Netcdf utility routines
- \ref PIO_enddef
- \ref PIO_redef
- \ref PIO_def_dim
- \ref PIO_def_var
\subsection inqnc NetCDF file inquiry routines
- \ref PIO_inquire
- \ref PIO_inq_attname
- \ref PIO_inq_att
- \ref PIO_inq_attlen
- \ref PIO_inquire_variable
- \ref PIO_inq_varid
- \ref PIO_inq_varname
- \ref PIO_inq_vartype
- \ref PIO_inq_varndims
- \ref PIO_inq_vardimid
- \ref PIO_inq_varnatts
- \ref PIO_inq_dimid
- \ref PIO_inq_dimname
- \ref PIO_inq_dimlen
- \ref PIO_inq_ndims
- \ref PIO_inq_nvars
- \ref PIO_inq_natts
- \ref PIO_inquire_variable
- \ref PIO_inquire_dimension
- \ref PIO_inquire_dimension

*/

0 comments on commit df2524b

Please sign in to comment.