netcdf-c/docs/mainpage.dox

/**
\mainpage Introduction and Overview

\tableofcontents

\section what_is_netcdf What is 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.  NetCDF was developed and is maintained at <a href="http://www.unidata.ucar.edu">Unidata</a>. Unidata provides data and software tools for use in geoscience education and research. Unidata is part of the University Corporation for Atmospheric Research (<a href="http://www2.ucar.edu">UCAR</a>) Community Programs (<a href="http://www.ucp.ucar.edu">UCP</a>). Unidata is funded primarily by the National Science Foundation.

The NetCDF homepage may be found at <a href="http://www.unidata.ucar.edu/software/netcdf/">http://www.unidata.ucar.edu/software/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>.

\subsection mainpage_learn_more_fortran Looking for NetCDF-Fortran Documentation?

You can find the documentation for netCDF-Fortran here:

- <a href="http://www.unidata.ucar.edu/software/netcdf/fortran/docs"> The NetCDF-Fortran Developer's Guide</a>

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

- \subpage RELEASE_NOTES
- \ref getting_and_building_netcdf

\subsection nightly_status The Latest NetCDF Build Status

\subsubsection NetCDF-C

- <A href="http://cdash.unidata.ucar.edu/index.php?project=netcdf-c">The netCDF-C Nightly and Continuous Integration Dashboard</A>
- <A href="https://travis-ci.org/Unidata/netcdf-c">NetCDF-C at Travis-CI</A>

\subsubsection NetCDF-Fortran


- <A href="http://cdash.unidata.ucar.edu/index.php?project=netcdf-fortran">The netCDF-Fortran Nightly and Continuous Integration Dashboard</A>
- <A href="https://travis-ci.org/Unidata/netcdf-c">NetCDF-Fortran at Travis-CI</A>

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

- \ref sec_tut
- \ref user_guide
- \ref netcdf_working_with_netcdf_files
- <a class="el" href="http://www.unidata.ucar.edu/software/netcdf/documentation/historic/">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

\section netcdf_credits About NetCDF

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

<p>NetCDF was developed and is maintained
at <a href="http://www.unidata.ucar.edu">Unidata</a>, part of the
<a href="http://www2.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.

A complete list of credits and contributors to NetCDF may be found at the \subpage credits page.

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


\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 put_vara_dispatch
- \ref put_attr_dispatch

\endinternal

*/
Further reorganization. Figured out how subpage works with different files. Renamed some of the header cells. 2014-12-10 07:36:15 +08:00			`/**`
More doxygen tweaks. 2016-01-16 03:23:56 +08:00			`\mainpage Introduction and Overview`
Updated and consolidated some redundant documentation. 2014-02-26 08:08:04 +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			`\tableofcontents`

Further reorganization. Figured out how subpage works with different files. Renamed some of the header cells. 2014-12-10 07:36:15 +08:00			`\section what_is_netcdf What is NetCDF?`
More reorganization of the documentation. o Updated the Doxyfile template to the latest version of doxygen (1.8.6). This shouldn't cause a problem; older versions will throw warnings about unrecognized options, but they should still build the documentation. o Added the 'netcdf' icon to doxygen-generated documentation. 2014-02-28 04:31:47 +08:00
Fixing links for document reorganization. 2016-01-16 05:25:24 +08:00			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. NetCDF was developed and is maintained at <a href="http://www.unidata.ucar.edu">Unidata</a>. Unidata provides data and software tools for use in geoscience education and research. Unidata is part of the University Corporation for Atmospheric Research (<a href="http://www2.ucar.edu">UCAR</a>) Community Programs (<a href="http://www.ucp.ucar.edu">UCP</a>). Unidata is funded primarily by the National Science Foundation.
More reorganization of the documentation. o Updated the Doxyfile template to the latest version of doxygen (1.8.6). This shouldn't cause a problem; older versions will throw warnings about unrecognized options, but they should still build the documentation. o Added the 'netcdf' icon to doxygen-generated documentation. 2014-02-28 04:31:47 +08:00
Fixing links for document reorganization. 2016-01-16 05:25:24 +08:00			`The NetCDF homepage may be found at <a href="http://www.unidata.ucar.edu/software/netcdf/">http://www.unidata.ucar.edu/software/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>.`
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
Updated mainpage.dox to make the netCDF-Fortran documentation link more obvious. 2019-02-16 07:44:45 +08:00			`\subsection mainpage_learn_more_fortran Looking for NetCDF-Fortran Documentation?`

			`You can find the documentation for netCDF-Fortran here:`

			`- <a href="http://www.unidata.ucar.edu/software/netcdf/fortran/docs"> The NetCDF-Fortran Developer's Guide</a>`

Further reorganization. Figured out how subpage works with different files. Renamed some of the header cells. 2014-12-10 07:36:15 +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
Further reorganization. Figured out how subpage works with different files. Renamed some of the header cells. 2014-12-10 07:36:15 +08:00			`- \subpage RELEASE_NOTES`
More reorganizing of the documentation generated by doxygen. Added a link to the main Unidata netcdf page to the footer, because we are going to turn off the header and footer on the web server. This should allow the Doxygen-generated search field to be properly placed. 2014-02-27 05:22:35 +08:00			`- \ref getting_and_building_netcdf`
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
More document reorganization. 2015-03-16 05:29:58 +08:00			`\subsection nightly_status The Latest NetCDF Build Status`
Reformatted the configuration summary message generated by cake. Turned off tree view for generated documentation (for the time being). Added a link to the Continuous Integration dashboard from the main page. 2014-03-09 08:04:14 +08:00
More document reorganization. 2015-03-16 05:29:58 +08:00			`\subsubsection NetCDF-C`

Corrected links to cdash dashboard. 2017-12-21 03:37:02 +08:00			`- <A href="http://cdash.unidata.ucar.edu/index.php?project=netcdf-c">The netCDF-C Nightly and Continuous Integration Dashboard</A>`
More document reorganization. 2015-03-16 05:29:58 +08:00			`- <A href="https://travis-ci.org/Unidata/netcdf-c">NetCDF-C at Travis-CI</A>`

			`\subsubsection NetCDF-Fortran`

Updated mainpage.dox to make the netCDF-Fortran documentation link more obvious. 2019-02-16 07:44:45 +08:00
Corrected links to cdash dashboard. 2017-12-21 03:37:02 +08:00			`- <A href="http://cdash.unidata.ucar.edu/index.php?project=netcdf-fortran">The netCDF-Fortran Nightly and Continuous Integration Dashboard</A>`
More document reorganization. 2015-03-16 05:29:58 +08:00			`- <A href="https://travis-ci.org/Unidata/netcdf-c">NetCDF-Fortran at Travis-CI</A>`
Reformatted the configuration summary message generated by cake. Turned off tree view for generated documentation (for the time being). Added a link to the Continuous Integration dashboard from the main page. 2014-03-09 08:04:14 +08:00
Further reorganization. Figured out how subpage works with different files. Renamed some of the header cells. 2014-12-10 07:36:15 +08:00			`\section learn-more Learn more about using NetCDF-C`
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
Fixed netcdf-c issue #30 (on github) related to cmake-generated nc-config script. Initial split of Guide from rest of documentation. Using 'tagfiles' to cross-reference from one documentation set to the other works, but then it drags all of the 'external' related pages into the index of the other. Modified visability of the external groups and pages. Adding proper section names to 'Example' sections, to avoid Doxygen warnings. Initial split of Guide from rest of documentation. Using 'tagfiles' to cross-reference from one documentation set to the other works, but then it drags all of the 'external' related pages into the index of the other. Modified visability of the external groups and pages. Adding proper section names to 'Example' sections, to avoid Doxygen warnings. Reorganizing documentation into two separate doxygen projects. Moved .texi documents into an old directory. Pulled the tutorial document into a separate document, similar to the guide document. Turned on treeview 2014-03-09 08:39:09 +08:00			`- \ref sec_tut`
took out fortran API, made some documentation changes 2011-08-12 01:54:34 +08:00			`- \ref user_guide`
More reorganizing of the documentation generated by doxygen. Added a link to the main Unidata netcdf page to the footer, because we are going to turn off the header and footer on the web server. This should allow the Doxygen-generated search field to be properly placed. 2014-02-27 05:22:35 +08:00			`- \ref netcdf_working_with_netcdf_files`
Fixing links for document reorganization. 2016-01-16 05:25:24 +08:00			`- <a class="el" href="http://www.unidata.ucar.edu/software/netcdf/documentation/historic/">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
Further reorganization. Figured out how subpage works with different files. Renamed some of the header cells. 2014-12-10 07:36:15 +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`

The 'Credits' page is now a generated document distributed with netcdf, even though the contents are static. It is currently included as a subpage underneath the NetCDF Overview page. Also, renamed 'Credits' on the Overview page to 'About NetCDF'. 2014-12-11 02:14:43 +08:00			`\section netcdf_credits About NetCDF`
More reorganizing of the documentation generated by doxygen. Added a link to the main Unidata netcdf page to the footer, because we are going to turn off the header and footer on the web server. This should allow the Doxygen-generated search field to be properly placed. 2014-02-27 05:22:35 +08:00
			`\authors Russ Rew, Glenn Davis, Steve Emmerson, Harvey Davies, Ed`
			`Hartnett, Dennis Heimbigner and Ward Fisher`

			`<p>NetCDF was developed and is maintained`
			`at <a href="http://www.unidata.ucar.edu">Unidata</a>, part of the`
Fixing links for document reorganization. 2016-01-16 05:25:24 +08:00			`<a href="http://www2.ucar.edu">University Corporation for Atmospheric Research</a> (UCAR) <a href="http://www.ucp.ucar.edu">Community`
More reorganizing of the documentation generated by doxygen. Added a link to the main Unidata netcdf page to the footer, because we are going to turn off the header and footer on the web server. This should allow the Doxygen-generated search field to be properly placed. 2014-02-27 05:22:35 +08:00			`Programs</a> (UCP). Unidata is funded primarily by the National Science`
			`Foundation.`

Additional dead link modification. 2016-01-16 05:39:32 +08:00			`A complete list of credits and contributors to NetCDF may be found at the \subpage credits page.`
More reorganizing of the documentation generated by doxygen. Added a link to the main Unidata netcdf page to the footer, because we are going to turn off the header and footer on the web server. This should allow the Doxygen-generated search field to be properly placed. 2014-02-27 05:22:35 +08:00
			`<a href="http://www.unidata.ucar.edu">Unidata</a> provides data and`
			`software tools for use in geoscience education and research.`


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			`\internal`
Updated CMake-related documentation in generated websites with more detail. 2013-06-05 01:33:21 +08:00
Added a new .gitignore specific to include/. Added netcdf_meta.h to user documentation generated by doxygen. 2014-09-19 05:05:08 +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 put_vara_dispatch`
			`- \ref put_attr_dispatch`

			`\endinternal`

beginning of conversion to doxygen 2011-07-12 00:04:49 +08:00			`*/`