Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merge doxygen2 into develop #553

Merged
merged 102 commits into from
Apr 26, 2021
Merged
Show file tree
Hide file tree
Changes from 89 commits
Commits
Show all changes
102 commits
Select commit Hold shift + click to select a range
57c19aa
Fixed warnings and started H5Epublic.h.
gheber Feb 6, 2021
12e79c2
Include H5FD* headers to correctly resolve references.
gheber Feb 6, 2021
0b86808
Doxygen2 (#330)
gheber Feb 12, 2021
5d44f21
Taking some inspiration from Eigen3.
gheber Feb 19, 2021
7a0443d
Add doxygen for the assigned functions: H5Pregister1,H5Pinsert1,H5Pen…
kyang2014 Feb 19, 2021
a9ee5b9
added documentation for H5P APIs (#350)
brtnfld Feb 19, 2021
ae0619e
Better name.
gheber Feb 19, 2021
e5ca525
Merge remote-tracking branch 'upstream/doxygen2' into doxygen2
gheber Feb 19, 2021
8a8cdb3
A fresh look.
gheber Feb 19, 2021
1e958d8
add doxygen to H5Ppublic.h
Feb 24, 2021
e58ef70
use attention instead of warning
Feb 24, 2021
06c9ebe
Add doxygen comments in H5Ppublic.h (#375)
ChristopherHogan Feb 25, 2021
2ee1821
add doxygen to H5Ppublic.h (#378)
jya-kmu Feb 25, 2021
f67cab0
Revert "add doxygen to H5Ppublic.h (#378)"
gheber Feb 26, 2021
3fbb3ec
Merge pull request #387 from HDFGroup/revert-378-doxygen2
gheber Feb 26, 2021
1ee4fd1
Updated Doxygen variables.
gheber Feb 26, 2021
b49fc31
Merge remote-tracking branch 'upstream/doxygen2' into doxygen21
gheber Feb 26, 2021
12e7d44
I forgot to copy two images.
gheber Mar 1, 2021
c34f347
Enable desktop search by default.
gheber Mar 1, 2021
861a297
Add my assigned Doxygen documentation.
gnuoyd Mar 1, 2021
f3de038
Remove whitespace at EOL. Appease clang-format.
gnuoyd Mar 1, 2021
0432851
Addressed Chris' comments.
gheber Mar 1, 2021
b101f90
Added an alias for asynchronous functions.
gheber Mar 1, 2021
60f37a9
One space is enough for all of us.
gheber Mar 1, 2021
62d12bf
Slightly restructured RM page.
gheber Mar 2, 2021
92bd93a
address some issues
Mar 2, 2021
627916f
reformatting
Mar 3, 2021
3ca85b0
Style external links.
gheber Mar 3, 2021
b352a95
reformatting
Mar 4, 2021
20c1cf1
reformatting
Mar 4, 2021
a89782a
Added "Metadata Caching in HDF5" as a technical note example.
gheber Mar 4, 2021
6d72b18
Revise this soon!
gheber Mar 4, 2021
be2bafa
Added specification examples.
gheber Mar 4, 2021
9b7b6a1
Fixed references.
gheber Mar 4, 2021
0d9b278
Merge pull request #402 from gheber/doxygen2
gheber Mar 5, 2021
0c94dd7
Merge pull request #415 from jya-kmu/doxygen2
jya-kmu Mar 5, 2021
4966a13
Added H5AC cache image stuff and file format study.
gheber Mar 5, 2021
41247ad
Added older FMT versions. Where did 1.0 go?
gheber Mar 6, 2021
38fd5f3
Updated C/C++ note and replaced ambiguous labels.
gheber Mar 8, 2021
8571a1a
Reformat source with clang v10.0.1.
lrknox Mar 11, 2021
3053650
Added the VFL technical note.
gheber Mar 11, 2021
d0e9525
Added what I believe might be called version 1.0 of the format.
gheber Mar 11, 2021
a0d9d12
Added the remaining specs.
gheber Mar 12, 2021
2285bbd
Added H5Z callback documentation and fixed a few mistakes.
gheber Mar 12, 2021
48ad87c
Merge pull request #407 from gnuoyd/doxygen2
gheber Mar 12, 2021
8c1488c
Merge remote-tracking branch 'upstream/doxygen2' into doxygen2
gheber Mar 12, 2021
b4e8c55
Added dox for deprecated H5G calls and fixed a few snippet blockIDs.
gheber Apr 5, 2021
4d3d76f
clang-format happy?
gheber Apr 5, 2021
d8ede70
Ok?
gheber Apr 5, 2021
b1f395b
Bonus track: Deprecated H5D functions.
gheber Apr 6, 2021
30cee2b
Carry over the more detailed group description.
gheber Apr 6, 2021
6dc33ad
Added documentation for the missing and deprecated H5R calls.
gheber Apr 6, 2021
0aa68cc
Life is easier and less repetitive w/ snippets. Use them!
gheber Apr 6, 2021
22f93e3
Eliminate the snippet block ID artifacts in the HTML rendering.
gheber Apr 8, 2021
0f0fb85
Fixed snippet HTML artifacts and added a few missing calls.
gheber Apr 9, 2021
da87917
Under 20 H5Ps to go!
gheber Apr 9, 2021
60d6eb2
Almost complete!
gheber Apr 9, 2021
08ebb4f
"This is a form of pedantry up with which I will not put." (Churchill)
gheber Apr 9, 2021
fe82783
Let's not waste as much space on bulleted lists!
gheber Apr 10, 2021
e1729c9
Merge pull request #542 from gheber/doxygen2
gheber Apr 10, 2021
dba0bb1
First complete (?) draft of the Doxygen-based RM.
gheber Apr 12, 2021
c849720
Completeness check and minor fixes along the way.
gheber Apr 12, 2021
cb812df
Pedantry.
gheber Apr 12, 2021
cbeddfa
Adding missing H5FD calls checkpoint.
gheber Apr 12, 2021
fca94d5
Pedantry.
gheber Apr 12, 2021
6ed4cfe
More pedantry.
gheber Apr 12, 2021
7ae9a3e
Added H5Pset_fapl_log.
gheber Apr 12, 2021
98934ec
First draft of H5ES.
gheber Apr 13, 2021
4a07933
Fixed warnings.
gheber Apr 13, 2021
e863439
Prep. for map module.
gheber Apr 13, 2021
656dc07
First cut of the map module.
gheber Apr 13, 2021
0a58bbd
Pedantry.
gheber Apr 13, 2021
00cc016
Possible H5F introduction.
gheber Apr 15, 2021
dee6299
Fix the indentation.
gheber Apr 15, 2021
e1a1921
Pedantry.
gheber Apr 15, 2021
77bc344
Ditto.
gheber Apr 15, 2021
46eb299
Thanks to the reviewers for their comments.
gheber Apr 15, 2021
41156c3
Added missing images.
gheber Apr 16, 2021
dfe70ae
Line numbers are a distraction here.
gheber Apr 16, 2021
fab1261
More examples, references, and clean-up. Don't repeat yourself!
gheber Apr 16, 2021
1060b0a
Clang pedantry.
gheber Apr 16, 2021
84dd30c
Ditto.
gheber Apr 16, 2021
db09dd0
More reviewer comments...
gheber Apr 16, 2021
85bf979
Templatized references and cleaned up \todos.
gheber Apr 16, 2021
8702250
Merge pull request #550 from gheber/doxygen2
gheber Apr 16, 2021
4f316e5
Merge remote-tracking branch 'origin/develop' into doxygen2
gheber Apr 19, 2021
7154720
Committing clang-format changes
github-actions[bot] Apr 19, 2021
0dc8f76
Fixed MANIFEST.
gheber Apr 19, 2021
1163030
Merge branch 'doxygen2' of github.com:gheber/hdf5 into doxygen2
gheber Apr 19, 2021
bd4c3ef
Addressed Quincey's comments. (OCPLs)
gheber Apr 19, 2021
4cf86af
Fixed a few more \todo items.
gheber Apr 22, 2021
22cd76b
Fixed more \todo items.
gheber Apr 22, 2021
28a7f44
Added attribute life cycle.
gheber Apr 22, 2021
580408b
Forgot the examples file.
gheber Apr 22, 2021
f91063a
Committing clang-format changes
github-actions[bot] Apr 22, 2021
f79c919
Pedantry.
gheber Apr 22, 2021
17afeb2
Merge branch 'doxygen2' of github.com:gheber/hdf5 into doxygen2
gheber Apr 22, 2021
7d03ec8
Live and learn!
gheber Apr 22, 2021
2c38922
Added a sample H5D life cycle.
gheber Apr 23, 2021
cbd87a8
Committing clang-format changes
github-actions[bot] Apr 23, 2021
1f3a01a
Pedantry.
gheber Apr 23, 2021
f06e6a3
Merge branch 'doxygen2' of github.com:gheber/hdf5 into doxygen2
gheber Apr 26, 2021
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
48 changes: 46 additions & 2 deletions MANIFEST
Original file line number Diff line number Diff line change
Expand Up @@ -209,7 +209,12 @@

./doxygen/aliases
./doxygen/Doxyfile.in
./doxygen/dox/api-compat-macros.dox
./doxygen/dox/About.dox
./doxygen/dox/Cookbook.dox
./doxygen/dox/DDLBNF110.dox
./doxygen/dox/DDLBNF112.dox
./doxygen/dox/FileFormatSpec.dox
./doxygen/dox/GettingStarted.dox
./doxygen/dox/H5AC_cache_config_t.dox
./doxygen/dox/H5Acreate.dox
./doxygen/dox/H5Aiterate.dox
Expand All @@ -226,12 +231,51 @@
./doxygen/dox/H5Ovisit_by_name.dox
./doxygen/dox/H5Ovisit.dox
./doxygen/dox/H5Sencode.dox
./doxygen/dox/mainpage.dox
./doxygen/dox/MetadataCachingInHDF5.dox
./doxygen/dox/OtherSpecs.dox
./doxygen/dox/Overview.dox
./doxygen/dox/ReferenceManual.dox
./doxygen/dox/Specifications.dox
./doxygen/dox/TechnicalNotes.dox
./doxygen/dox/api-compat-macros.dox
./doxygen/dox/maybe_metadata_reads.dox
./doxygen/dox/rm-template.dox
./doxygen/examples/FF-IH_FileGroup.gif
./doxygen/examples/FF-IH_FileObject.gif
./doxygen/examples/FileFormatSpecChunkDiagram.jpg
./doxygen/examples/H5Pset_metadata_read_attempts.c
./doxygen/examples/H5Pset_object_flush_cb.c
./doxygen/examples/H5.format.1.0.html
./doxygen/examples/H5.format.1.1.html
./doxygen/examples/H5.format.2.0.html
./doxygen/examples/H5.format.html
./doxygen/examples/H5Fclose.c
./doxygen/examples/H5Fcreate.c
./doxygen/examples/H5F_examples.c
./doxygen/examples/H5Pget_metadata_read_attempts.1.c
./doxygen/examples/H5Pget_metadata_read_attempts.2.c
./doxygen/examples/H5Pget_metadata_read_attempts.3.c
./doxygen/examples/H5Pget_object_flush_cb.c
./doxygen/examples/ImageSpec.html
./doxygen/examples/PaletteExample1.gif
./doxygen/examples/Palettes.fm.anc.gif
./doxygen/examples/TableSpec.html
./doxygen/examples/ThreadSafeLibrary.html
./doxygen/examples/VFL.html
./doxygen/examples/hello_hdf5.c
./doxygen/hdf5_footer.html
./doxygen/hdf5_header.html
./doxygen/hdf5_navtree_hacks.js
./doxygen/hdf5doxy.css
./doxygen/hdf5doxy_layout.xml
./doxygen/img/FF-IH_FileGroup.gif
./doxygen/img/FF-IH_FileObject.gif
./doxygen/img/FileFormatSpecChunkDiagram.jpg
./doxygen/img/HDFG-logo.png
./doxygen/img/PaletteExample1.gif
./doxygen/img/Palettes.fm.anc.gif
./doxygen/img/ftv2node.png
./doxygen/img/ftv2pnode.png

./examples/Attributes.txt
./examples/Makefile.am
Expand Down
24 changes: 21 additions & 3 deletions configure.ac
Original file line number Diff line number Diff line change
Expand Up @@ -95,12 +95,12 @@ AC_CONFIG_COMMANDS([pubconf], [
sed 's/#define /#define H5_/' <src/H5config.h |\
sed 's/#undef /#undef H5_/' >pubconf
if test ! -f src/H5pubconf.h; then
/bin/mv -f pubconf src/H5pubconf.h
mv -f pubconf src/H5pubconf.h
elif (diff pubconf src/H5pubconf.h >/dev/null); then
rm -f pubconf
echo "src/H5pubconf.h is unchanged"
else
/bin/mv -f pubconf src/H5pubconf.h
mv -f pubconf src/H5pubconf.h
fi
echo "Post process src/libhdf5.settings"
sed '/^#/d' < src/libhdf5.settings > libhdf5.settings.TMP
Expand Down Expand Up @@ -1116,16 +1116,34 @@ if test "X$HDF5_DOXYGEN" = "Xyes"; then
AC_SUBST([DOXYGEN_OPTIMIZE_OUTPUT_FOR_C])
AC_SUBST([DOXYGEN_MACRO_EXPANSION])
AC_SUBST([DOXYGEN_OUTPUT_DIRECTORY])
AC_SUBST([DOXYGEN_EXAMPLES_DIRECTORY])
AC_SUBST([DOXYGEN_LAYOUT_FILE])
AC_SUBST([DOXYGEN_HTML_HEADER])
AC_SUBST([DOXYGEN_HTML_FOOTER])
AC_SUBST([DOXYGEN_HTML_EXTRA_STYLESHEET])
AC_SUBST([DOXYGEN_HTML_EXTRA_FILES])
AC_SUBST([DOXYGEN_SERVER_BASED_SEARCH])
AC_SUBST([DOXYGEN_EXTERNAL_SEARCH])
AC_SUBST([DOXYGEN_SEARCHENGINE_URL])

DOXYGEN_PACKAGE=${PACKAGE_NAME}
DOXYGEN_VERSION_STRING=${PACKAGE_VERSION}
DOXYGEN_INCLUDE_ALIASES='$(SRCDIR)/doxygen/aliases'
DOXYGEN_PROJECT_LOGO='$(SRCDIR)/doxygen/img/HDFG-logo.png'
DOXYGEN_PROJECT_BRIEF="C-API Reference"
DOXYGEN_PROJECT_BRIEF=
DOXYGEN_INPUT_DIRECTORY='$(SRCDIR) $(SRCDIR)/doxygen/dox'
DOXYGEN_OPTIMIZE_OUTPUT_FOR_C=YES
DOXYGEN_MACRO_EXPANSION=YES
DOXYGEN_OUTPUT_DIRECTORY=hdf5lib_docs
DOXYGEN_EXAMPLES_DIRECTORY='$(SRCDIR)/doxygen/examples'
DOXYGEN_LAYOUT_FILE='$(SRCDIR)/doxygen/hdf5doxy_layout.xml'
DOXYGEN_HTML_HEADER='$(SRCDIR)/doxygen/hdf5_header.html'
DOXYGEN_HTML_FOOTER='$(SRCDIR)/doxygen/hdf5_footer.html'
DOXYGEN_HTML_EXTRA_STYLESHEET='$(SRCDIR)/doxygen/hdf5doxy.css'
DOXYGEN_HTML_EXTRA_FILES='$(SRCDIR)/doxygen/hdf5_navtree_hacks.js $(SRCDIR)/doxygen/img/ftv2node.png $(SRCDIR)/doxygen/img/ftv2pnode.png'
DOXYGEN_SERVER_BASED_SEARCH=NO
DOXYGEN_EXTERNAL_SEARCH=NO
DOXYGEN_SEARCHENGINE_URL=

DX_INIT_DOXYGEN([HDF5], [../doxygen/Doxyfile], [hdf5lib_docs])

Expand Down
35 changes: 22 additions & 13 deletions doxygen/Doxyfile.in
Original file line number Diff line number Diff line change
Expand Up @@ -738,7 +738,7 @@ FILE_VERSION_FILTER =
# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE
# tag is left empty.

LAYOUT_FILE =
LAYOUT_FILE = @DOXYGEN_LAYOUT_FILE@

# The CITE_BIB_FILES tag can be used to specify one or more bib files containing
# the reference definitions. This must be a list of .bib files. The .bib
Expand Down Expand Up @@ -855,7 +855,16 @@ INPUT_ENCODING = UTF-8

FILE_PATTERNS = H5*public.h \
H5*module.h \
H5FDcore.h \
H5FDdirect.h \
H5FDfamily.h \
H5FDlog.h \
H5FDmpi.h \
H5FDmpio.h \
H5FDmulti.h \
H5FDsec2.h \
H5FDstdio.h \
H5FDwindows.h \
H5VLconnector.h \
H5VLconnector_passthru.h \
H5VLnative.h \
Expand Down Expand Up @@ -908,7 +917,7 @@ EXCLUDE_SYMBOLS =
# that contain example code fragments that are included (see the \include
# command).

EXAMPLE_PATH = ../src ../examples ../test examples
EXAMPLE_PATH = ../src ../examples ../test @DOXYGEN_EXAMPLES_DIRECTORY@

# If the value of the EXAMPLE_PATH tag contains directories, you can use the
# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and
Expand Down Expand Up @@ -1169,7 +1178,7 @@ HTML_FILE_EXTENSION = .html
# of the possible markers and block names see the documentation.
# This tag requires that the tag GENERATE_HTML is set to YES.

HTML_HEADER =
HTML_HEADER = @DOXYGEN_HTML_HEADER@

# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each
# generated HTML page. If the tag is left blank doxygen will generate a standard
Expand All @@ -1179,7 +1188,7 @@ HTML_HEADER =
# that doxygen normally uses.
# This tag requires that the tag GENERATE_HTML is set to YES.

HTML_FOOTER =
HTML_FOOTER = @DOXYGEN_HTML_FOOTER@

# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style
# sheet that is used by each HTML page. It can be used to fine-tune the look of
Expand All @@ -1204,7 +1213,7 @@ HTML_STYLESHEET =
# list). For an example see the documentation.
# This tag requires that the tag GENERATE_HTML is set to YES.

HTML_EXTRA_STYLESHEET =
HTML_EXTRA_STYLESHEET = @DOXYGEN_HTML_EXTRA_STYLESHEET@

# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
# other source files which should be copied to the HTML output directory. Note
Expand All @@ -1214,7 +1223,7 @@ HTML_EXTRA_STYLESHEET =
# files will be copied as-is; there are no commands or markers available.
# This tag requires that the tag GENERATE_HTML is set to YES.

HTML_EXTRA_FILES =
HTML_EXTRA_FILES = @DOXYGEN_HTML_EXTRA_FILES@

# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen
# will adjust the colors in the style sheet and background images according to
Expand Down Expand Up @@ -1272,7 +1281,7 @@ HTML_DYNAMIC_MENUS = NO
# The default value is: NO.
# This tag requires that the tag GENERATE_HTML is set to YES.

HTML_DYNAMIC_SECTIONS = NO
HTML_DYNAMIC_SECTIONS = YES

# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries
# shown in the various tree structured indices initially; the user can expand
Expand Down Expand Up @@ -1484,7 +1493,7 @@ ECLIPSE_DOC_ID = org.doxygen.Project
# The default value is: NO.
# This tag requires that the tag GENERATE_HTML is set to YES.

DISABLE_INDEX = NO
DISABLE_INDEX = YES

# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
# structure should be generated to display hierarchical information. If the tag
Expand Down Expand Up @@ -1632,7 +1641,7 @@ MATHJAX_CODEFILE =
# The default value is: YES.
# This tag requires that the tag GENERATE_HTML is set to YES.

SEARCHENGINE = NO
SEARCHENGINE = YES

# When the SERVER_BASED_SEARCH tag is enabled the search engine will be
# implemented using a web server instead of a web client using JavaScript. There
Expand All @@ -1644,7 +1653,7 @@ SEARCHENGINE = NO
# The default value is: NO.
# This tag requires that the tag SEARCHENGINE is set to YES.

SERVER_BASED_SEARCH = YES
SERVER_BASED_SEARCH = @DOXYGEN_SERVER_BASED_SEARCH@

# When EXTERNAL_SEARCH tag is enabled doxygen will no longer generate the PHP
# script for searching. Instead the search results are written to an XML file
Expand All @@ -1660,7 +1669,7 @@ SERVER_BASED_SEARCH = YES
# The default value is: NO.
# This tag requires that the tag SEARCHENGINE is set to YES.

EXTERNAL_SEARCH = NO
EXTERNAL_SEARCH = @DOXYGEN_EXTERNAL_SEARCH@

# The SEARCHENGINE_URL should point to a search engine hosted by a web server
# which will return the search results when EXTERNAL_SEARCH is enabled.
Expand All @@ -1671,7 +1680,7 @@ EXTERNAL_SEARCH = NO
# Searching" for details.
# This tag requires that the tag SEARCHENGINE is set to YES.

SEARCHENGINE_URL =
SEARCHENGINE_URL = @DOXYGEN_SEARCHENGINE_URL@

# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the unindexed
# search data is written to a file for indexing by an external tool. With the
Expand Down Expand Up @@ -2168,7 +2177,7 @@ INCLUDE_FILE_PATTERNS =
# recursively expanded use the := operator instead of the = operator.
# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.

PREDEFINED =
PREDEFINED = H5_HAVE_PARALLEL

# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this
# tag can be used to specify a list of macro names that should be expanded. The
Expand Down
Loading