mirror of
https://github.com/HDFGroup/hdf5.git
synced 2024-12-21 07:51:46 +08:00
e56b0a3d50
* Sketch of the H5S life cycle. * Committing clang-format changes * Fix H5S_UNLIMITED snafu. * Updated RM template and RM page. * Added H5S life cycle. * Committing clang-format changes * Added H5T life cycle. * Committing clang-format changes * Cleaner layout (?) * Cleaned the H5F life cycle. Called out unfinished biz. * Committing clang-format changes * Remaining life cycle skeletons. * Committing clang-format changes * Committing clang-format changes * Added H5Z life cycle. * Committing clang-format changes * Added H5G life cycle. * Committing clang-format changes * H5 and H5I life cycle updates. * Committing clang-format changes * Added H5PL life cycle. * Committing clang-format changes * Added H5L life cycle. * Committing clang-format changes * Fix for Chris' comment. * Add a variable for Doxygen pre-processor definitions. * Forgot to add the H5M API. * Clarify the H5Z life cycle. * Committing clang-format changes * Add H5Zdevelop.h to Doxygen.in. Added H5I life cycle. * Committing clang-format changes * Clarified introduction and fixed missing label declaration. * Added H5O life cycle. * Committing clang-format changes * H5O cleanup, part 1. * Committing clang-format changes * Cleaned up some of the endless repetition in H5O. * Committing clang-format changes * Cookbook & RFC draft layouts. * Updated manifest. * Updated the manifest, the example paths, and sketched the 1st recipe. * Committing clang-format changes * Outlined two more recipes. * Committing clang-format changes * More recipes and RFCs. * Committing clang-format changes * Draft of templatized RFC references. * Another batch of RFC changes. * Another batch of RFCs. * Fixed reference. * RFCs in reverse chronological order. * First cut of RFCs. * Fixed reference. * Updated recipes. * Updated recipes. * More RFCs. * Updated D*PL comments. * Added H5P descriptions. * Committing clang-format changes * H5R life-cycle snapshot. * Committing clang-format changes * H5R life-cycle. Added line numbers to life-cycle examples. * Committing clang-format changes * Fixed formatting for H5Dchunk_iter(). * Added comment on collective mode requirement w/ compression. * Simplified API compat. macro dox. * More API vers. updates. * Hide the async macro entrails. * Latest VFD SWMR RFC. * Create a tag file for permalinks. * Added TODOs for metadoc. * Removed duplication. * Revised RM landing page. * Trimmed more duplication. * Committing clang-format changes * Revised H5D. * Committing clang-format changes * Updated survey link. * Added Doxygen RM entry template link. * Added the "Multi-Thread HDF5" RFC. * Added DOXYGEN_TAG_FILE. * Added selection I/O RFC. * Added the VFD Sub-filing RFC. * Updated meta-documentation and added two old presentations. * Added a few more RFCs (4). * Fixed MANIFEST. * Updated meta-documentation. * Added Filters technical note. * Fixed MANIFEST. * Restore the path stripper. * Experimental full-text search via Google. * Better full-text search integration. * Whoops. Forgot this one. * Oh boy. * Make CMake happy. * Added "Debugging HDF5 Applications" technical note. * Another batch of RFCs. * Fixes for #1221. * Updated overview. * Fixed image dependencies. * CMake updates. * Fixed SET. * Better? * Update doxygen/dox/Overview.dox * Fixed documentation errors. Added missing version info. * Callback documentation updates. * Fixed indexing errors in the outline. * Doxygen-ized the HDF5 glossary. * Fix a few minor typos . Co-authored-by: github-actions <41898282+github-actions[bot]@users.noreply.github.com> Co-authored-by: Larry Knox <lrknox@hdfgroup.org>
47 lines
2.0 KiB
Plaintext
47 lines
2.0 KiB
Plaintext
|
|
/** \mainpage notitle
|
|
|
|
This is the documentation set for HDF5.
|
|
It includes specifications and documentation
|
|
of software and tools developed and maintained by
|
|
<a href="https://www.hdfgroup.org/">The HDF Group</a>. It is impractical to document
|
|
the entire HDF5 ecosystem in one place, and you should also consult the documentation
|
|
sets of the many outstanding community projects.
|
|
|
|
For a first contact with HDF5, the best place is to have a look at the \link
|
|
GettingStarted getting started \endlink page that shows you how to write and
|
|
compile your first program with HDF5.
|
|
|
|
The \b main \b documentation is organized by documentation flavor. Most
|
|
technical documentation consists to varying degrees of information related to
|
|
<em>tasks</em>, <em>concepts</em>, or <em>reference</em> material. As its title
|
|
suggests, the \link RM Reference Manual \endlink is 100% reference material,
|
|
while the \link Cookbook \endlink is focused on tasks. The different guide-type
|
|
documents cover a mix of tasks, concepts, and reference, to help a specific
|
|
<em>audience</em> succeed.
|
|
|
|
\par Versions
|
|
Version-specific documentation (see the version in the title area) can be found
|
|
here:
|
|
- HDF5 <code>develop</code> branch (this site)
|
|
- <a href="https://docs.hdfgroup.org/hdf5/v1_12/index.html">HDF5 1.12.x</a>
|
|
- <a href="https://docs.hdfgroup.org/hdf5/v1_10/index.html">HDF5 1.10.x</a>
|
|
- <a href="https://docs.hdfgroup.org/hdf5/v1_8/index.html">HDF5 1.8.x</a>
|
|
|
|
\par Search
|
|
If you are looking for a specific function, constant, type, etc., use the
|
|
search box in the top right-hand corner!\n Otherwise, check out the
|
|
\link FTS full-text search\endlink.
|
|
|
|
\par Offline reading
|
|
You can <a href="hdf5-doc.tgz">download</a> it as a tgz archive for offline reading.
|
|
|
|
\par History
|
|
A snapshot (~April 2017) of the pre-Doxygen HDF5 documentation can be found
|
|
<a href="https://docs.hdfgroup.org/archive/support/HDF5/doc/index.html">here</a>.
|
|
|
|
\par ToDo List
|
|
There is plenty of <a href="./todo.html">unfinished business</a>.
|
|
|
|
*/
|