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

Split doxygen pages from spec and TN into files #5165

Merged
merged 4 commits into from
Dec 13, 2024

Conversation

byrnHDF
Copy link
Contributor

@byrnHDF byrnHDF commented Dec 3, 2024

Improves maintenance of pages involved.

@byrnHDF byrnHDF added Component - Documentation Doxygen, markdown, etc. Type - Improvement Improvements that don't add a new feature or functionality labels Dec 3, 2024
@byrnHDF byrnHDF self-assigned this Dec 3, 2024
performance, datatype conversion, data space conversion, and data filters. The code is
included on a per-package basis and enabled at runtime by an environment variable.

\subsection subsec_adddbg_intro_trace API Tracing
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

API Tracing was removed in #4341

/** \page TBLSPEC HDF5 Table Specification Version 1.0
The HDF5 specification defines the standard objects and storage for the standard HDF5
objects. (For information about the HDF5 library, model and specification, see the HDF
documentation.) This document is an additional specification do define a standard profile
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

do define -> to define


<b>Mac OS</b> systems generally handle UTF-8 encodings correctly.

<b>Windows</b> systems use a different Unicode encoding, UCS-2 (discussed in this UTF-16 article) at
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No article linked here. Probably supposed to link to https://en.wikipedia.org/wiki/UTF-16

attempt to maintain a free list for that particular object type, instead calling the file driver
each time an object of that type is freed.

Mappings predefined in the 'H5FDpublic.h' file are:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These are defined in H5FDdevelop.h at present

<table>
<tr>
<td><code>static herr_t read (H5FD_t *file, H5FD_mem_t type, hid_t dxpl, haddr_t addr, hsize_t size, void *buf)</code></td>
<td>The read function reads data from file file beginning at address addr and continuing
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

file file -> file

Copy link
Contributor

@mattjala mattjala left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A few typos and out of date info

@byrnHDF
Copy link
Contributor Author

byrnHDF commented Dec 3, 2024

A few typos and out of date info

Updated

mattjala
mattjala previously approved these changes Dec 12, 2024
lrknox
lrknox previously approved these changes Dec 12, 2024
@lrknox lrknox dismissed stale reviews from mattjala and themself via 09ccbce December 12, 2024 22:07
@lrknox lrknox merged commit 8c7fe81 into HDFGroup:develop Dec 13, 2024
68 checks passed
byrnHDF added a commit to byrnHDF/hdf5 that referenced this pull request Dec 17, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Component - Documentation Doxygen, markdown, etc. Type - Improvement Improvements that don't add a new feature or functionality
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants