Files
Scot Breitenfeld 05676d1abe Consolidate documentation under docs/ directory (#6310)
* Consolidate documentation under doc/ directory

Move user-facing guides from release_docs/ and doxygen/ into a single
doc/ root. release_docs/ now holds only release artifacts (changelogs,
history, release process, maintainer info).

- git mv release_docs/INSTALL*.md, USING_*.md, README_HPC.md,
  BuildSystemNotes.md, AutotoolsToCMakeOptions.md,
  HDF5_Library_2.0.0_Migration_Guide.md → doc/
- git mv doxygen/ → doc/doxygen/
- Update CMakeLists.txt: HDF5_DOXYGEN_DIR and add_subdirectory path
- Update CMakeInstallation.cmake: all install paths for moved files
- Update bin/make_vers: hardcoded doxygen/ path substitution
- Update doc/doxygen/CMakeLists.txt: EXAMPLES_DIRECTORY and comments
- Update README.md, CONTRIBUTING.md, SECURITY.md, config/README.md,
  release_docs/RELEASE_PROCESS.md: links to moved files
- Update doxygen .dox files: release_docs/ URLs for moved guides
- Rewrite release_docs/README.md for narrowed scope

* Add HDF5_DOCS_DIR variable for doc/ root path

Introduce HDF5_DOCS_DIR = \${HDF5_SOURCE_DIR}/doc so that
CMakeInstallation.cmake and future callers reference the doc/
directory symbolically rather than by hardcoded path.
HDF5_DOXYGEN_DIR is now derived from HDF5_DOCS_DIR.
2026-03-31 17:01:54 -06:00

84 lines
1.9 KiB
Markdown

<b>Java Library</b>
@ref HDF5LIB
- @ref JH5
<br />
This package is the Java interface for the HDF5 library.
- @ref JH5A
<br />
This package is the Java interface for the HDF5 library attribute APIs.
- @ref JH5D
<br />
This package is the Java interface for the HDF5 library dataset APIs.
- @ref JH5S
<br />
This package is the Java interface for the HDF5 library dataspace APIs.
- @ref JH5T
<br />
This package is the Java interface for the HDF5 library datatype APIs.
- @ref JH5E
<br />
This package is the Java interface for the HDF5 library error APIs.
- @ref JH5F
<br />
This package is the Java interface for the HDF5 library file APIs.
- @ref JH5Z
<br />
This package is the Java interface for the HDF5 library filter APIs.
- @ref JH5G
<br />
This package is the Java interface for the HDF5 library group APIs.
- @ref JH5I
<br />
This package is the Java interface for the HDF5 library identifier APIs.
- @ref JH5L
<br />
This package is the Java interface for the HDF5 library links APIs.
- @ref JH5O
<br />
This package is the Java interface for the HDF5 library object APIs.
- @ref JH5P
<br />
This package is the Java interface for the HDF5 library property list APIs.
- @ref JH5PL
<br />
This package is the Java interface for the HDF5 library plugin APIs.
- @ref JH5R
<br />
This package is the Java interface for the HDF5 library reference APIs.
- @ref JH5VL
<br />
This package is the Java interface for the HDF5 library VOL connector APIs.
- @ref HDF5CONST
<br />
This class contains C constants and enumerated types of HDF5 library.
- @ref HDFNATIVE
<br />
This class encapsulates native methods to deal with arrays of numbers,
* converting from numbers to bytes and bytes to numbers.
- @ref HDFARRAY
<br />
This is a class for handling multidimensional arrays for HDF.
- @ref ERRORS
<br />
The class HDF5Exception returns errors from the Java HDF5 Interface.