Skip to content

Commit

Permalink
Convert HL Dim Scales doc to doxy UG (#5152)
Browse files Browse the repository at this point in the history
  • Loading branch information
byrnHDF authored Dec 3, 2024
1 parent 40f5f5e commit f075377
Show file tree
Hide file tree
Showing 11 changed files with 740 additions and 4 deletions.
2 changes: 1 addition & 1 deletion doxygen/dox/Overview.dox
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ documents cover a mix of tasks, concepts, and reference, to help a specific
<em>audience</em> succeed.

\par Offline reading
You can <a href="https://\RELURL/v1_14/v1_14_5/hdf5-1.14.5.doxygen.zip">download</a> it as an archive for offline reading.
You can <a href="https://\RELURL/v1_14/v1_14_5/downloads/hdf5-1.14.5.doxygen.zip">download</a> it as an archive for offline reading.

\par ToDo List
There is plenty of <a href="./todo.html">unfinished business</a>.
Expand Down
17 changes: 17 additions & 0 deletions doxygen/dox/UsersGuide.dox
Original file line number Diff line number Diff line change
Expand Up @@ -335,6 +335,23 @@

\ref sec_map

\section sec_hl HDF5 High Level APIs
\li \ref H5DO_UG
<ul>
<li> \ref sec_hldo_direct_chunk
</ul>
\li \ref H5DS_UG
<ul>
<li> \ref sec_dim_scales_stand
<li> \ref sec_dim_scales_concept
<li> \ref sec_dim_scales_spec
<li> \ref sec_dim_scales_api
</ul>
\li \ref H5IM_UG
\li \ref H5LT_UG
\li \ref H5TB_UG
\li \ref H5PT_UG

\ref sec_cltools
\li \ref H5TOOL_CP_UG
\li \ref H5TOOL_DF_UG
Expand Down
3 changes: 2 additions & 1 deletion doxygen/dox/VOLConnGuide.dox
Original file line number Diff line number Diff line change
Expand Up @@ -191,7 +191,8 @@ are for connector testing and should not be found in the wild. Values of 512 to
connectors.

As is the case with HDF5 filters, The HDF Group can assign you an official VOL connector value. Please
contact <a href="[email protected]">[email protected]</a> for help with this. We currently do not register connector names, though the
contact <a href="mailto:[email protected]">[email protected]</a> for help with this. We currently do not
register connector names, though the
name you've chosen will appear on the registered VOL connectors page.

As noted above, registered VOL connectors will be listed at:
Expand Down
Binary file removed doxygen/examples/H5DS_Spec.pdf
Binary file not shown.
Binary file added doxygen/img/H5DS_fig1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doxygen/img/H5DS_fig2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doxygen/img/H5DS_fig3.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doxygen/img/H5DS_fig4.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doxygen/img/H5DS_fig5.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
719 changes: 719 additions & 0 deletions hl/src/H5DSpublic.h

Large diffs are not rendered by default.

3 changes: 1 addition & 2 deletions src/H5Ppublic.h
Original file line number Diff line number Diff line change
Expand Up @@ -3913,8 +3913,7 @@ H5_DLL herr_t H5Pget_mdc_image_config(hid_t plist_id, H5AC_cache_image_config_t
* access property list, and H5Fget_mdc_logging_status() will return
* the current state of the logging flags.
*
* The log format is described in the
* <a href="https://bit.ly/2PG6fNv">Metadata Cache Logging</a> document.
* The log format is described in the \ref_mdc_logging document.
*
* \since 1.10.0
*/
Expand Down

0 comments on commit f075377

Please sign in to comment.