Skip to content

Commit e979eee

Browse files
bmriblerbmribler
authored
Add release 1.14.6 page to doxygen docs (#6110)
1 parent c0d2cf6 commit e979eee

3 files changed

Lines changed: 109 additions & 17 deletions

File tree

‎doxygen/aliases‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ ALIASES += RFCURL="\DOCURL/rfc"
1818
ALIASES += AEXURL="\HDFURL/archive/support/ftp/HDF5/examples"
1919
#branch name (develop, hdf5_2_0_0)
2020
ALIASES += SRCURL="github.com/HDFGroup/hdf5/blob/develop"
21-
ALIASES += SRCURL20="github.com/HDFGroup/hdf5/blob/hdf5_2_0_0"
21+
ALIASES += SRCURL114="github.com/HDFGroup/hdf5/blob/hdf5_1.14.6"
2222
#Other projects that contribute to HDF5
2323
ALIASES += PRJURL="\HDFURL/archive/support/projects"
2424
ALIASES += HVURL="github.com/HDFGroup/hdfview/blob/master"

‎doxygen/dox/hdf5_1_14.dox‎

Lines changed: 102 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,108 @@
33
* Navigate back: \ref index "Main" / \ref release_specific_info
44
* <hr>
55

6+
7+
\section sec_rel_spec_114 HDF5 Library and Tools 1.14.6
8+
9+
\subsection subsec_rel_info_114 Release Information
10+
11+
<table>
12+
<tr>
13+
<td style="background-color:#F5F5F5">
14+
Version
15+
</td>
16+
<td>
17+
HDF5 1.14.6
18+
</td>
19+
</tr>
20+
<tr>
21+
<td style="background-color:#F5F5F5">
22+
Release Date
23+
</td>
24+
<td>
25+
02/05/25
26+
</td>
27+
</tr>
28+
<tr>
29+
<td style="background-color:#F5F5F5">
30+
Additional Release Information
31+
</td>
32+
<td>
33+
<a href="https://\SRCURL114/release_docs/RELEASE.txt">RELEASE.txt</a>
34+
</td>
35+
</tr>
36+
<tr>
37+
<td style="background-color:#F5F5F5">
38+
</td>
39+
<td>
40+
\ref sec_rel_spec_114_migrate
41+
</td>
42+
</tr>
43+
<tr>
44+
<td style="background-color:#F5F5F5">
45+
</td>
46+
<td>
47+
\ref sec_rel_spec_114_change
48+
</td>
49+
</tr>
50+
<tr>
51+
<td style="background-color:#F5F5F5">
52+
</td>
53+
<td>
54+
\ref sec_rel_spec_114_feat
55+
</td>
56+
</tr>
57+
<tr>
58+
<td style="background-color:#F5F5F5">
59+
</td>
60+
<td>
61+
[Newsletter Announcement](https://www.hdfgroup.org/2025/02/05/release-of-hdf5-1-14-6-newsletter-205/)
62+
</td>
63+
</tr>
64+
<tr>
65+
<td style="background-color:#F5F5F5">
66+
</td>
67+
<td>
68+
ABI/API compatibility reports between 1.14.6 and 1.14.5 [tar file](https://\RELURL/v1_14/v1_14_6/downloads/hdf5-1.14.6.html.abi.reports.tar.gz) or [individual html files](https://\RELURL/v1_14/v1_14_6/downloads/compat_report/index.html)
69+
</td>
70+
</tr>
71+
<tr>
72+
<td style="background-color:#F5F5F5">
73+
</td>
74+
<td>
75+
[Doxygen generated Reference Manual](https://support.hdfgroup.org/documentation/hdf5/latest/)
76+
</td>
77+
</tr>
78+
</table>
79+
80+
81+
\subsection subsec_download_114 Downloads
82+
83+
Source code and binaries are available at:
84+
<a href="https://\RELURL/v1_14/v1_14_6/downloads/index.html">https://support.hdfgroup.org/releases/hdf5/v1_14/v1_14_6</a>
85+
86+
Please refer to [Build instructions](https://\SRCURL/release_docs/INSTALL) for building with either CMake or Autotools.
87+
88+
89+
\subsection subsec_obtain_method_114 Methods to obtain (gz file)
90+
91+
\li firefox – Download file and then run: `gzip <distribution>.tar.gz | tar xzf -`
92+
\li chrome – Download file and then run: `gzip -cd <distribution>.tar.gz | tar xvf -`
93+
\li wget –
94+
<div style="margin-left: 2em;">
95+
`wget https://github.com/HDFGroup/hdf5/releases/download/${PACKAGEVERSION}/<distribution>.tar.gz`<br>
96+
`gzip -cd <distribution>.tar.gz | tar xvf -`
97+
</div>
98+
\li `<distribution>` is hdf5-${PACKAGEVERSION}, where PACKAGEVERSION is 1.14.6 for this release
99+
100+
101+
\subsection subsec_dox_gen_doc_114 Doxygen Generated Reference Manual
102+
103+
The new HDF5 documentation based on [Doxygen](https://www.doxygen.nl/index.html) is available \ref index "here".
104+
105+
This documentation is WORK-IN-PROGRESS.
106+
Since this portion of the HDF5 documentation is now part of the source code, it gets the same treatment as code. In other words, issues, inaccuracies, corrections should be reported as issues in [GitHub](https://github.com/HDFGroup/hdf5/issues), and pull requests will be reviewed and accepted as any other code changes.
107+
6108
\section sec_rel_spec_114_migrate Migrating from HDF5 1.12 to HDF5 1.14
7109
# Migrating to HDF5 1.14 from Previous Versions of HDF5
8110

‎doxygen/dox/hdf5_2_0.dox‎

Lines changed: 6 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55

66
\section sec_rel_spec_20 HDF5 Library and Tools 2.0.0
77

8-
\subsection subsec_rel_info Release Information
8+
\subsection subsec_rel_info_20 Release Information
99

1010
<table>
1111
<tr>
@@ -64,7 +64,7 @@ Additional Release Information
6464
<td style="background-color:#F5F5F5">
6565
</td>
6666
<td>
67-
[API Compatibility Reports between 2.0.0 and 1.14.6](https://\RELURL/v2_0/v2_0_0/downloads/hdf5-2.0.0.html.abi.reports.tar.gz)
67+
ABI/API Compatibility Reports between 2.0.0 and 1.14.6 [tar file](https://\RELURL/v2_0/v2_0_0/downloads/hdf5-2.0.0.html.abi.reports.tar.gz) or [individual html files](https://\RELURL/v2_0/v2_0_0/downloads/compat_report/index.html)
6868
</td>
6969
</tr>
7070
<tr>
@@ -77,15 +77,15 @@ Additional Release Information
7777
</table>
7878

7979

80-
\subsection subsec_download Downloads
80+
\subsection subsec_download_20 Downloads
8181

8282
Source code and binaries are available at:
8383
<a href="https://github.com/HDFGroup/hdf5/releases/tag/2.0.0">HDF5 2.0.0 on GitHub</a>
8484

85-
Please refer to [Build instructions](https://\SRCURL/release_docs/INSTALL) for building with either CMake or Autotools.
85+
Please refer to [Build instructions](https://\SRCURL/release_docs/INSTALL) for building with CMake.
8686

8787

88-
\subsection subsec_obtain_method Methods to obtain (gz file)
88+
\subsection subsec_obtain_method_20 Methods to obtain (gz file)
8989

9090
\li firefox – Download file and then run: `gzip <distribution>.tar.gz | tar xzf -`
9191
\li chrome – Download file and then run: `gzip -cd <distribution>.tar.gz | tar xvf -`
@@ -96,18 +96,8 @@ Please refer to [Build instructions](https://\SRCURL/release_docs/INSTALL) for b
9696
</div>
9797
\li `<distribution>` is hdf5-${PACKAGEVERSION}, where PACKAGEVERSION is 2.0.0 for this release
9898

99-
\subsection subsec_api_compat_reps Individual API Compatibility Reports
10099

101-
* [hdf5-2.0-hdf5_compat_report.html](https://\RELURL/v2_0/v2_0_0/downloads/compat_report/hdf5-2.0.0-hdf5_compat_report.html) -- HTML C library ABI report file
102-
103-
* [hdf5-2.0-hdf5_cpp_compat_report.html](https://\RELURL/v2_0/v2_0_0/downloads/compat_report/hdf5-2.0.0-hdf5_cpp_compat_report.html) -- HTML CPP library ABI report file
104-
105-
* [hdf5-2.0-hdf5_hl_compat_report.html](https://\RELURL/v2_0/v2_0_0/downloads/compat_report/hdf5-2.0.0-hdf5_hl_compat_report.html) -- HTML HL C library ABI report file
106-
107-
* [hdf5-2.0-java_compat_report.html](https://\RELURL/v2_0/v2_0_0/downloads/compat_report/hdf5-2.0.0-java_compat_report.html) -- HTML Java library ABI report file
108-
109-
110-
\subsection subsec_dox_gen_doc Doxygen Generated Reference Manual
100+
\subsection subsec_dox_gen_doc_20 Doxygen Generated Reference Manual
111101

112102
The new HDF5 documentation based on [Doxygen](https://www.doxygen.nl/index.html) is available \ref index "here".
113103

0 commit comments

Comments
 (0)