mirror of
https://github.com/HDFGroup/hdf5.git
synced 2024-12-27 08:01:04 +08:00
1d680fe04c
* Fixed warnings and started H5Epublic.h.
* Include H5FD* headers to correctly resolve references.
* Doxygen2 (#330)
* H5Eauto_is_v2.
* Added a few more calls.
* Added a few more H5E calls.
* First cut of H5E v2.
* Added the deprecated v1 calls.
* Updated spacing.
* Once more.
* Taking some inspiration from Eigen3.
* Add doxygen for the assigned functions: H5Pregister1,H5Pinsert1,H5Pen… (#352)
* Add doxygen for the assigned functions: H5Pregister1,H5Pinsert1,H5Pencode1, H5Pget_filter_by_id1,H5Pget_version, H5Pset_file_space,H5Pget_file_space. Someone already adds H5Pget_filter1. Also fixs an extra parameter 'close' call back function for HPregister2.
* doxygen work. fixs format by using clang-format.
* doxgen work for H5Pregister1 etc. Addressed Barbara and Gerd's comments.
For Quincey's comments, since we are not supposed to change the source code.
I leave this to future improvements.
* added documentation for H5P APIs (#350)
* add documenation for H5Pget_buffer,H5Pget_data_transform,H5Pget_edc_check,H5Pget_hyper_vector_size,H5Pget_preserve,H5Pget_type_conv_cb,H5Pget_vlen_mem_manager,H5Pset_btree_ratios
* format corrections
* fixed grammer
* fixed herr_t
* Better name.
* A fresh look.
* add doxygen to H5Ppublic.h
* use attention instead of warning
* Add doxygen comments in H5Ppublic.h (#375)
* Add doxygen comments in H5Ppublic.h
* H5Pset_meta_block_size
* H5Pset_metadata_read_attempts
* H5Pset_multi_type
* H5Pset_object_flush_cb
* H5Pset_sieve_buf_size
* H5Pset_small_data_block_size
* H5Pset_all_coll_metadata_ops
* H5Pget_all_coll_metadata_ops
* Add DOXYGEN_EXAMPLES_DIR to src/CMakeLists.txt
* Fix clang-format errors
* Fix filenames in doxygen/examples
* add doxygen to H5Ppublic.h (#378)
* add doxygen to H5Ppublic.h
* use attention instead of warning
Co-authored-by: Kimmy Mu <kmu@hdfgroup.org>
* Revert "add doxygen to H5Ppublic.h (#378)"
This reverts commit 2ee1821b13.
* Updated Doxygen variables.
* I forgot to copy two images.
* Enable desktop search by default.
* Add my assigned Doxygen documentation.
* Remove whitespace at EOL. Appease clang-format.
* Addressed Chris' comments.
* Added an alias for asynchronous functions.
* One space is enough for all of us.
* Slightly restructured RM page.
* address some issues
* reformatting
* Style external links.
* reformatting
* reformatting
* Added "Metadata Caching in HDF5" as a technical note example.
* Revise this soon!
* Added specification examples.
* Fixed references.
* Added H5AC cache image stuff and file format study.
* Added older FMT versions. Where did 1.0 go?
* Updated C/C++ note and replaced ambiguous labels.
* Reformat source with clang v10.0.1.
* Added the VFL technical note.
* Added what I believe might be called version 1.0 of the format.
* Added the remaining specs.
* Added H5Z callback documentation and fixed a few mistakes.
* Added dox for deprecated H5G calls and fixed a few snippet blockIDs.
* clang-format happy?
* Ok?
* Bonus track: Deprecated H5D functions.
* Carry over the more detailed group description.
* Added documentation for the missing and deprecated H5R calls.
* Life is easier and less repetitive w/ snippets. Use them!
* Eliminate the snippet block ID artifacts in the HTML rendering.
* Fixed snippet HTML artifacts and added a few missing calls.
* Under 20 H5Ps to go!
* Almost complete!
* "This is a form of pedantry up with which I will not put." (Churchill)
* Let's not waste as much space on bulleted lists!
* First complete (?) draft of the Doxygen-based RM.
* Completeness check and minor fixes along the way.
* Pedantry.
* Adding missing H5FD calls checkpoint.
* Pedantry.
* More pedantry.
* Added H5Pset_fapl_log.
* First draft of H5ES.
* Fixed warnings.
* Prep. for map module.
* First cut of the map module.
* Pedantry.
* Possible H5F introduction.
* Fix the indentation.
* Pedantry.
* Ditto.
* Thanks to the reviewers for their comments.
* Added missing images.
* Line numbers are a distraction here.
* More examples, references, and clean-up. Don't repeat yourself!
* Clang pedantry.
* Ditto.
* More reviewer comments...
* Templatized references and cleaned up \todos.
* Committing clang-format changes
* Fixed MANIFEST.
* Addressed Quincey's comments. (OCPLs)
* Fixed a few more \todo items.
* Fixed more \todo items.
* Added attribute life cycle.
* Forgot the examples file.
* Committing clang-format changes
* Pedantry.
* Live and learn!
* Added a sample H5D life cycle.
* Committing clang-format changes
* Pedantry.
Co-authored-by: kyang2014 <kyang2014@users.noreply.github.com>
Co-authored-by: Scot Breitenfeld <brtnfld@hdfgroup.org>
Co-authored-by: Kimmy Mu <kmu@hdfgroup.org>
Co-authored-by: Christopher Hogan <ChristopherHogan@users.noreply.github.com>
Co-authored-by: jya-kmu <53388330+jya-kmu@users.noreply.github.com>
Co-authored-by: David Young <dyoung@hdfgroup.org>
Co-authored-by: Larry Knox <lrknox@hdfgroup.org>
Co-authored-by: github-actions <41898282+github-actions[bot]@users.noreply.github.com>
183 lines
5.6 KiB
XML
183 lines
5.6 KiB
XML
<?xml version="1.0"?>
|
|
<doxygenlayout version="1.0">
|
|
<!-- Navigation index tabs for HTML output -->
|
|
<navindex>
|
|
<tab type="user" url="index.html" title="Overview" />
|
|
<tab type="user" url="https://portal.hdfgroup.org/display/HDF5/Learning+HDF5" title="Getting started" />
|
|
<tab type="user" url="@ref Cookbook" title="Cookbook" />
|
|
<tab type="user" url="https://portal.hdfgroup.org/display/HDF5/HDF5+User+Guides" title="User Guides" />
|
|
<tab type="user" url="https://portal.hdfgroup.org/display/HDF5/HDF5+Application+Developer%27s+Guide" title="Application Developer's Guide" />
|
|
<tab type="user" url="https://portal.hdfgroup.org/display/HDF5/HDF5+Glossary" title="Glossary" />
|
|
<tab type="user" url="@ref RM" title="Reference Manual" />
|
|
<tab type="user" url="@ref TN" title="Technical Notes" />
|
|
<tab type="user" url="@ref SPEC" title="Specifications" />
|
|
<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>
|