Skip to content

Commit

Permalink
Upgrade doxygen to develop standard (#5261)
Browse files Browse the repository at this point in the history
  • Loading branch information
byrnHDF authored Jan 23, 2025
1 parent 064f0a1 commit e104e50
Show file tree
Hide file tree
Showing 147 changed files with 25,939 additions and 54,241 deletions.
2 changes: 1 addition & 1 deletion .codespellrc
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,4 @@
skip = .git,*.svg,.codespellrc,./bin/trace,./hl/tools/h5watch/h5watch.c,./tools/test/h5jam/tellub.c,./config/sanitizer/LICENSE,./config/sanitizer/sanitizers.cmake,./tools/test/h5import/testfiles/*.conf,./tools/test/h5repack/testfiles/*.dat,./test/API/driver,./configure,./bin/ltmain.sh,./bin/depcomp,./bin/config.guess,./bin/config.sub,./autom4te.cache,./m4/libtool.m4,./c++/src/*.html,./HDF5Examples/depcomp,./release_docs/HISTORY-*.txt
check-hidden = true
# ignore-regex =
ignore-words-list = ot,isnt,inout,nd,parms,parm,ba,offsetP,ser,ois,had,fiter,fo,clude,refere,minnum,offsetp,creat,ans:,eiter,lastr,ans,isn't,ifset,sur,trun,dne,tthe,hda,filname,te,htmp,ake,gord,numer,ro,oce,msdos,TEXTIN,indx
ignore-words-list = ot,isnt,inout,nd,parms,parm,ba,offsetP,ser,ois,had,fiter,fo,clude,refere,minnum,offsetp,creat,ans:,eiter,lastr,ans,isn't,ifset,sur,trun,dne,tthe,hda,filname,te,htmp,ake,gord,numer,ro,oce,msdos,TEXTIN,indx,FLE
4 changes: 2 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -122,10 +122,10 @@ Please make sure that you check the items applicable to your pull request:
* [ ] If changes were done to Autotools build, were they added to CMake and vice versa?
* [ ] Is the pull request applicable to any other branches? If yes, which ones? Please document it in the GitHub issue.
* [ ] Is the new code sufficiently documented for future maintenance?
* [ ] Does the new feature require a change to an existing API? See "API Compatibility Macros" document (https://support.hdfgroup.org/releases/hdf5/v1_14/v1_14_5/documentation/doxygen/api-compat-macros.html)
* [ ] Does the new feature require a change to an existing API? See "API Compatibility Macros" document (https://support.hdfgroup.org/releases/hdf5/v1_14/v1_14_6/documentation/doxygen/api-compat-macros.html)
* Documentation
* [ ] Was the change described in the release_docs/RELEASE.txt file?
* [ ] Was the new function documented in the corresponding public header file using [Doxygen](https://support.hdfgroup.org/releases/hdf5/v1_14/v1_14_5/documentation/doxygen/_r_m_t.html)?
* [ ] Was the new function documented in the corresponding public header file using [Doxygen](https://support.hdfgroup.org/releases/hdf5/v1_14/v1_14_6/documentation/doxygen/_r_m_t.html)?
* [ ] Was new functionality documented for the HDF5 community (the level of documentation depends on the feature; ask us what would be appropriate)
* Testing
* [ ] Does the pull request have tests?
Expand Down
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,15 +23,15 @@ DOCUMENTATION
-------------
This release is fully functional for the API described in the documentation.

https://support.hdfgroup.org/releases/hdf5/v1_14/v1_14_5/documentation/doxygen/_l_b_a_p_i.html
https://support.hdfgroup.org/releases/hdf5/v1_14/v1_14_6/documentation/doxygen/_l_b_a_p_i.html

Full Documentation and Programming Resources for this release can be found at

https://support.hdfgroup.org/releases/hdf5/v1_14/v1_14_5/documentation/doxygen/index.html
https://support.hdfgroup.org/releases/hdf5/v1_14/v1_14_6/documentation/doxygen/index.html

The latest doxygen documentation generated on changes to HDF5 1.14.x is available at:

https://support.hdfgroup.org/releases/hdf5/v1_14/v1_14_5/documentation/doxygen
https://support.hdfgroup.org/releases/hdf5/v1_14/v1_14_6/documentation/doxygen

See the [RELEASE.txt](release_docs/RELEASE.txt) file in the [release_docs/](release_docs/) directory for information specific
to the features and updates included in this release of the library.
Expand Down
40 changes: 0 additions & 40 deletions doc/branches-explained.md

This file was deleted.

57 changes: 0 additions & 57 deletions doc/code-conventions.md

This file was deleted.

56 changes: 0 additions & 56 deletions doc/library-init-shutdown.md

This file was deleted.

16 changes: 0 additions & 16 deletions doc/threadsafety-warning.md

This file was deleted.

1 change: 1 addition & 0 deletions doxygen/Doxyfile.in
Original file line number Diff line number Diff line change
Expand Up @@ -684,6 +684,7 @@ FILE_PATTERNS = H5*public.h H5*module.h H5*develop.h H5FD*.h \
H5VLconnector.h H5VLconnector_passthru.h H5VLnative.h H5PLextern.h \
H5Zdevelop.h \
H5version.h \
Callbacks.java \
H5*.java \
HDF*.java \
*.F90 \
Expand Down
Loading

0 comments on commit e104e50

Please sign in to comment.