netcdf-c/man4/mainpage.dox

/** \file 
This header file holds the documentation for the main page.

\mainpage

\tableofcontents

\section NetCDF

NetCDF is a set of software libraries and self-describing,
machine-independent data formats that support the creation, access,
and sharing of array-oriented scientific data. The NetCDF homepage may be found at <a href="http://www.unidata.ucar.edu/netcdf">http://www.unidata.ucar.edu/netcdf</a>.  The NetCDF source-code is hosted at <a href="http://github.com">GitHub</a>, and may be found directly at <a href="http://github.com/Unidata/netcdf-c">http://github.com/Unidata/netcdf-c</a>.

\section credits Credits

<p>NetCDF was developed and is maintained
at <a href="http://www.unidata.ucar.edu">Unidata</a>, part of the
<a href="http://www.ucar.edu">University Corporation for Atmospheric Research</a> (UCAR) <a href="http://www.ucp.ucar.edu">Community
Programs</a> (UCP). Unidata is funded primarily by the National Science
Foundation.

\authors Russ Rew, Glenn Davis, Steve Emmerson, Harvey Davies, Ed
Hartnett, Dennis Heimbigner and Ward Fisher

\section this_release Learn more about the current NetCDF-C Release

- \ref release_notes
- \ref getting
- \ref building

\section learn-more Learn more about using NetCDF-C

- \ref tutorial
- \ref user_guide
- <a class="el" href="http://www.unidata.ucar.edu/software/netcdf/docs/index-413.html">Older Documentation, plus details regarding netcdf-fortran and netcdf-cxx.</a>


\section netcdf-cmake-windows NetCDF CMake and Windows support:
- \ref netCDF-CMake
- \ref winbin

\internal

Internal Documentation 

The dispatch interface within the netCDF library allows the netCDF API
to be used for different types of back-ends, for example, the HDF5
library, or a DAP client accessing remote data.
- \ref nc_dispatch
- \ref adding_dispatch
- \ref dispatch_notes
- \ref put_vara_dispatch
- \ref put_attr_dispatch

\endinternal

<a href="http://www.unidata.ucar.edu">Unidata</a> provides data and
software tools for use in geoscience education and research.

*/
beginning of conversion to doxygen 2011-07-12 00:04:49 +08:00			`/** \file`
			`This header file holds the documentation for the main page.`

			`\mainpage`

Reorganized files to reduce clutter and to make things a little more coherent. This is an ongoing process. 2014-02-25 07:06:09 +08:00			`\tableofcontents`

Updated CMake-related documentation in generated websites with more detail. 2013-06-05 01:33:21 +08:00			`\section NetCDF`

beginning of conversion to doxygen 2011-07-12 00:04:49 +08:00			`NetCDF is a set of software libraries and self-describing,`
			`machine-independent data formats that support the creation, access,`
Updated Cmake builds to properly manage the 'ENABLE_INTERNAL_DOCS' option. Reformatted documentation to make things a little more cohesive. 2014-02-21 06:48:01 +08:00			`and sharing of array-oriented scientific data. The NetCDF homepage may be found at <a href="http://www.unidata.ucar.edu/netcdf">http://www.unidata.ucar.edu/netcdf</a>. The NetCDF source-code is hosted at <a href="http://github.com">GitHub</a>, and may be found directly at <a href="http://github.com/Unidata/netcdf-c">http://github.com/Unidata/netcdf-c</a>.`

Reorganized files to reduce clutter and to make things a little more coherent. This is an ongoing process. 2014-02-25 07:06:09 +08:00			`\section credits Credits`
beginning of conversion to doxygen 2011-07-12 00:04:49 +08:00
fixed name of UOP 2011-08-16 18:15:55 +08:00			`<p>NetCDF was developed and is maintained`
			`at <a href="http://www.unidata.ucar.edu">Unidata</a>, part of the`
			`<a href="http://www.ucar.edu">University Corporation for Atmospheric Research</a> (UCAR) <a href="http://www.ucp.ucar.edu">Community`
			`Programs</a> (UCP). Unidata is funded primarily by the National Science`
beginning of conversion to doxygen 2011-07-12 00:04:49 +08:00			`Foundation.`

			`\authors Russ Rew, Glenn Davis, Steve Emmerson, Harvey Davies, Ed`
Corrected CMake behavior in doxygen. Updated documentation to reflect location of CMake-related Documentation for netCDF-C. 2013-01-31 05:13:32 +08:00			`Hartnett, Dennis Heimbigner and Ward Fisher`
beginning of conversion to doxygen 2011-07-12 00:04:49 +08:00
Reorganized files to reduce clutter and to make things a little more coherent. This is an ongoing process. 2014-02-25 07:06:09 +08:00			`\section this_release Learn more about the current NetCDF-C Release`
Updated Cmake builds to properly manage the 'ENABLE_INTERNAL_DOCS' option. Reformatted documentation to make things a little more cohesive. 2014-02-21 06:48:01 +08:00
Added markdown version of RELEASE_NOTES for evaluation. Modified Doxyfile templates to generate html from the markdown file (assumes doxygen version 1.8+) Added link to release notes to mainpage.doc 2013-05-08 04:54:54 +08:00			`- \ref release_notes`
removed cxx and cxx4, bumped version to 4.2, and fixed up documentation some 2011-08-11 02:00:32 +08:00			`- \ref getting`
			`- \ref building`
Reorganized files to reduce clutter and to make things a little more coherent. This is an ongoing process. 2014-02-25 07:06:09 +08:00
			`\section learn-more Learn more about using NetCDF-C`

removed cxx and cxx4, bumped version to 4.2, and fixed up documentation some 2011-08-11 02:00:32 +08:00			`- \ref tutorial`
took out fortran API, made some documentation changes 2011-08-12 01:54:34 +08:00			`- \ref user_guide`
Reorganized files to reduce clutter and to make things a little more coherent. This is an ongoing process. 2014-02-25 07:06:09 +08:00			`- <a class="el" href="http://www.unidata.ucar.edu/software/netcdf/docs/index-413.html">Older Documentation, plus details regarding netcdf-fortran and netcdf-cxx.</a>`
Updated CMake-related documentation in generated websites with more detail. 2013-06-05 01:33:21 +08:00
added some internal documentation to doxygen documentation 2011-08-22 21:53:37 +08:00
Reorganized files to reduce clutter and to make things a little more coherent. This is an ongoing process. 2014-02-25 07:06:09 +08:00			`\section netcdf-cmake-windows NetCDF CMake and Windows support:`
Updated Cmake builds to properly manage the 'ENABLE_INTERNAL_DOCS' option. Reformatted documentation to make things a little more cohesive. 2014-02-21 06:48:01 +08:00			`- \ref netCDF-CMake`
			`- \ref winbin`

			`\internal`
Updated CMake-related documentation in generated websites with more detail. 2013-06-05 01:33:21 +08:00
Removed 'section' flag that was causing a problem with the 'internal' flag. 2014-02-22 07:34:13 +08:00			`Internal Documentation`
Updated CMake-related documentation in generated websites with more detail. 2013-06-05 01:33:21 +08:00
added some internal documentation to doxygen documentation 2011-08-22 21:53:37 +08:00			`The dispatch interface within the netCDF library allows the netCDF API`
			`to be used for different types of back-ends, for example, the HDF5`
			`library, or a DAP client accessing remote data.`
			`- \ref nc_dispatch`
			`- \ref adding_dispatch`
			`- \ref dispatch_notes`
			`- \ref put_vara_dispatch`
			`- \ref put_attr_dispatch`

			`\endinternal`

fixed name of UOP 2011-08-16 18:15:55 +08:00			`<a href="http://www.unidata.ucar.edu">Unidata</a> provides data and`
			`software tools for use in geoscience education and research.`
beginning of conversion to doxygen 2011-07-12 00:04:49 +08:00
			`*/`