mirror of
https://github.com/HDFGroup/hdf5.git
synced 2026-09-25 04:09:44 +03:00
Scot Breitenfeld
05676d1abe
* 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.
187 lines
6.0 KiB
XML
187 lines
6.0 KiB
XML
<?xml version="1.0"?>
|
|
<doxygenlayout version="1.0">
|
|
<!-- Navigation index tabs for HTML output -->
|
|
<navindex>
|
|
<tab type="user" url="@ref GettingStarted" title="Getting started" />
|
|
<tab type="user" url="@ref UG" title="User Guide" />
|
|
<tab type="user" url="@ref RM" title="Reference Manual" />
|
|
<!-- <tab type="user" url="https://support.hdfgroup.org/releases/hdf5/documentation/HDF5+Application+Developer%27s+Guide" title="Application Developer's Guide" />
|
|
<tab type="user" url="https://support.hdfgroup.org/releases/hdf5/documentation/An_Overview_of_the_HDF5_Library_Architecture.v2.pdf" title="HDF5 Library Architecture Overview" /> -->
|
|
<tab type="user" url="@ref Cookbook" title="Cookbook" />
|
|
<tab type="user" url="@ref TN" title="Technical Notes" />
|
|
<!-- <tab type="user" url="@ref VOL_Connector" title="HDF5 VOL Connector Author Guide" />
|
|
<tab type="user" url="https://support.hdfgroup.org/releases/hdf5/documentation/HDF5+VOL+User%27s+Guide" title="HDF5 VOL User's Guide" /> -->
|
|
<tab type="user" url="@ref RFC" title="RFCs" />
|
|
<tab type="user" url="@ref SPEC" title="Specifications" />
|
|
<tab type="user" url="@ref GLS" title="Glossary" />
|
|
<tab type="user" url="@ref FTS" title="Full-Text Search" />
|
|
<tab type="user" url="@ref About" title="About" />
|
|
</navindex>
|
|
|
|
<!-- Layout definition for a class page -->
|
|
<class>
|
|
<briefdescription visible="no"/>
|
|
<includes visible="$SHOW_INCLUDE_FILES"/>
|
|
<detaileddescription title=""/>
|
|
<inheritancegraph visible="$CLASS_GRAPH"/>
|
|
<collaborationgraph visible="$COLLABORATION_GRAPH"/>
|
|
<allmemberslink visible="yes"/>
|
|
<memberdecl>
|
|
<nestedclasses visible="yes" title=""/>
|
|
<publictypes title=""/>
|
|
<publicslots title=""/>
|
|
<signals title=""/>
|
|
<publicmethods title=""/>
|
|
<publicstaticmethods title=""/>
|
|
<publicattributes title=""/>
|
|
<publicstaticattributes title=""/>
|
|
<protectedtypes title=""/>
|
|
<protectedslots title=""/>
|
|
<protectedmethods title=""/>
|
|
<protectedstaticmethods title=""/>
|
|
<protectedattributes title=""/>
|
|
<protectedstaticattributes title=""/>
|
|
<packagetypes title=""/>
|
|
<packagemethods title=""/>
|
|
<packagestaticmethods title=""/>
|
|
<packageattributes title=""/>
|
|
<packagestaticattributes title=""/>
|
|
<properties title=""/>
|
|
<events title=""/>
|
|
<privatetypes title=""/>
|
|
<privateslots title=""/>
|
|
<privatemethods title=""/>
|
|
<privatestaticmethods title=""/>
|
|
<privateattributes title=""/>
|
|
<privatestaticattributes title=""/>
|
|
<friends title=""/>
|
|
<related title="" subtitle=""/>
|
|
<membergroups visible="yes"/>
|
|
</memberdecl>
|
|
|
|
<memberdef>
|
|
<inlineclasses title=""/>
|
|
<typedefs title=""/>
|
|
<enums title=""/>
|
|
<constructors title=""/>
|
|
<functions title=""/>
|
|
<related title=""/>
|
|
<variables title=""/>
|
|
<properties title=""/>
|
|
<events title=""/>
|
|
</memberdef>
|
|
<usedfiles visible="$SHOW_USED_FILES"/>
|
|
<authorsection visible="yes"/>
|
|
</class>
|
|
|
|
<!-- Layout definition for a namespace page -->
|
|
<namespace>
|
|
<briefdescription visible="yes"/>
|
|
<memberdecl>
|
|
<nestednamespaces visible="yes" title=""/>
|
|
<classes visible="yes" title=""/>
|
|
<typedefs title=""/>
|
|
<enums title=""/>
|
|
<functions title=""/>
|
|
<variables title=""/>
|
|
<membergroups visible="yes"/>
|
|
</memberdecl>
|
|
<detaileddescription title=""/>
|
|
<memberdef>
|
|
<inlineclasses title=""/>
|
|
<typedefs title=""/>
|
|
<enums title=""/>
|
|
<functions title=""/>
|
|
<variables title=""/>
|
|
</memberdef>
|
|
<authorsection visible="yes"/>
|
|
</namespace>
|
|
|
|
<!-- Layout definition for a file page -->
|
|
<file>
|
|
<briefdescription visible="yes"/>
|
|
<includes visible="$SHOW_INCLUDE_FILES"/>
|
|
<includegraph visible="$INCLUDE_GRAPH"/>
|
|
<includedbygraph visible="$INCLUDED_BY_GRAPH"/>
|
|
<sourcelink visible="yes"/>
|
|
<memberdecl>
|
|
<classes visible="yes" title=""/>
|
|
<namespaces visible="yes" title=""/>
|
|
<defines title=""/>
|
|
<typedefs title=""/>
|
|
<enums title=""/>
|
|
<functions title=""/>
|
|
<variables title=""/>
|
|
<membergroups visible="yes"/>
|
|
</memberdecl>
|
|
<detaileddescription title=""/>
|
|
<memberdef>
|
|
<inlineclasses title=""/>
|
|
<defines title=""/>
|
|
<typedefs title=""/>
|
|
<enums title=""/>
|
|
<functions title=""/>
|
|
<variables title=""/>
|
|
</memberdef>
|
|
<authorsection/>
|
|
</file>
|
|
|
|
<!-- Layout definition for a group page -->
|
|
<group>
|
|
<briefdescription visible="no"/>
|
|
<detaileddescription title=""/>
|
|
<groupgraph visible="$GROUP_GRAPHS"/>
|
|
<memberdecl>
|
|
<nestedgroups visible="yes" title=""/>
|
|
<dirs visible="yes" title=""/>
|
|
<files visible="yes" title=""/>
|
|
<namespaces visible="yes" title=""/>
|
|
<classes visible="yes" title=""/>
|
|
<defines title=""/>
|
|
<typedefs title=""/>
|
|
<enums title=""/>
|
|
<enumvalues title=""/>
|
|
<functions title=""/>
|
|
<variables title=""/>
|
|
<signals title=""/>
|
|
<publicslots title=""/>
|
|
<protectedslots title=""/>
|
|
<privateslots title=""/>
|
|
<events title=""/>
|
|
<properties title=""/>
|
|
<friends title=""/>
|
|
<membergroups visible="yes"/>
|
|
</memberdecl>
|
|
|
|
<memberdef>
|
|
<pagedocs/>
|
|
<inlineclasses title=""/>
|
|
<defines title=""/>
|
|
<typedefs title=""/>
|
|
<enums title=""/>
|
|
<enumvalues title=""/>
|
|
<functions title=""/>
|
|
<variables title=""/>
|
|
<signals title=""/>
|
|
<publicslots title=""/>
|
|
<protectedslots title=""/>
|
|
<privateslots title=""/>
|
|
<events title=""/>
|
|
<properties title=""/>
|
|
<friends title=""/>
|
|
</memberdef>
|
|
<authorsection visible="yes"/>
|
|
</group>
|
|
|
|
<!-- Layout definition for a directory page -->
|
|
<directory>
|
|
<briefdescription visible="yes"/>
|
|
<directorygraph visible="yes"/>
|
|
<memberdecl>
|
|
<dirs visible="yes"/>
|
|
<files visible="yes"/>
|
|
</memberdecl>
|
|
<detaileddescription title=""/>
|
|
</directory>
|
|
</doxygenlayout>
|