mirror of
https://github.com/HDFGroup/hdf5.git
synced 2026-09-25 04:09:44 +03:00
235 lines
16 KiB
HTML
235 lines
16 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
|
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
|
|
<meta name="generator" content="Doxygen 1.16.1"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>HDF5: About</title>
|
|
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="jquery.js"></script>
|
|
<script type="text/javascript" src="dynsections.js"></script>
|
|
<link href="navtree.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="navtreedata.js"></script>
|
|
<script type="text/javascript" src="navtree.js"></script>
|
|
<script type="text/javascript" src="cookie.js"></script>
|
|
<link href="search/search.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="search/searchdata.js"></script>
|
|
<script type="text/javascript" src="search/search.js"></script>
|
|
<script type="text/javascript">
|
|
$(function() { init_search(); });
|
|
</script>
|
|
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
|
<link href="hdf5doxy.css" rel="stylesheet" type="text/css"/>
|
|
<link href="doxygen-awesome.css" rel="stylesheet" type="text/css"/>
|
|
<link href="hdf5doxy.css" rel="stylesheet" type="text/css">
|
|
<script type="text/javascript" src="hdf5_navtree_hacks.js"></script>
|
|
<div style="background:#FFDDDD;font-size:120%;text-align:center;margin:0;padding:5px">Help us improve by taking our short survey: <a href="https://www.hdfgroup.org/website-survey/">https://www.hdfgroup.org/website-survey/</a></div>
|
|
<!-- ... other metadata & script includes ... -->
|
|
<script type="text/javascript" src="doxygen-awesome-tabs.js"></script>
|
|
<script type="text/javascript">
|
|
DoxygenAwesomeTabs.init()
|
|
</script>
|
|
<!-- Google tag (gtag.js) -->
|
|
<script async src="https://www.googletagmanager.com/gtag/js?id=G-57FMZK4S7X"></script>
|
|
<script>
|
|
window.dataLayer = window.dataLayer || [];
|
|
function gtag(){dataLayer.push(arguments);}
|
|
gtag('js', new Date());
|
|
gtag('config', 'G-57FMZK4S7X');
|
|
</script>
|
|
</head>
|
|
<body>
|
|
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
|
<div id="titlearea">
|
|
<table cellspacing="0" cellpadding="0">
|
|
<tbody>
|
|
<tr id="projectrow">
|
|
<td id="projectlogo"><img alt="Logo" src="HDFG-logo.png"/></td>
|
|
<td id="projectalign">
|
|
<div id="projectname">HDF5<span id="projectnumber"> Last Updated on 2026-07-14</span>
|
|
</div>
|
|
<div id="projectbrief">The HDF5 Field Guide</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.16.1 -->
|
|
<script type="text/javascript">
|
|
var searchBox = new SearchBox("searchBox", "search/",'.html');
|
|
</script>
|
|
<script type="text/javascript">
|
|
$(function() { codefold.init(); });
|
|
</script>
|
|
<div id="main-nav">
|
|
<div id="navrow1" class="tabs">
|
|
<ul class="tablist">
|
|
<li><a href="index.html"><span>Main Page</span></a></li>
|
|
<li><a href="_getting_started.html"><span>Getting started</span></a></li>
|
|
<li><a href="_u_g.html"><span>User Guide</span></a></li>
|
|
<li><a href="_r_m.html"><span>Reference Manual</span></a></li>
|
|
<li><a href="_cookbook.html"><span>Cookbook</span></a></li>
|
|
<li><a href="_t_n.html"><span>Technical Notes</span></a></li>
|
|
<li><a href="_r_f_c.html"><span>RFCs</span></a></li>
|
|
<li><a href="_s_p_e_c.html"><span>Specifications</span></a></li>
|
|
<li><a href="_g_l_s.html"><span>Glossary</span></a></li>
|
|
<li><a href="_f_t_s.html"><span>Full-Text Search</span></a></li>
|
|
<li><a href="_about.html"><span>About</span></a></li>
|
|
<li>
|
|
<div id="MSearchBox" class="MSearchBoxInactive">
|
|
<span class="left">
|
|
<span id="MSearchSelect" class="search-icon" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()"><span class="search-icon-dropdown"></span></span>
|
|
<input type="text" id="MSearchField" value="" placeholder="Search" accesskey="S"
|
|
onfocus="searchBox.OnSearchFieldFocus(true)"
|
|
onblur="searchBox.OnSearchFieldFocus(false)"
|
|
onkeyup="searchBox.OnSearchFieldChange(event)"/>
|
|
</span><span class="right">
|
|
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><div id="MSearchCloseImg" class="close-icon"></div></a>
|
|
</span>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div><!-- main-nav -->
|
|
</div><!-- top -->
|
|
<div id="side-nav" class="ui-resizable side-nav-resizable">
|
|
<div id="nav-tree">
|
|
<div id="nav-tree-contents">
|
|
<div id="nav-sync" class="sync"></div>
|
|
</div>
|
|
</div>
|
|
<div id="splitbar" style="-moz-user-select:none;"
|
|
class="ui-resizable-handle">
|
|
</div>
|
|
</div>
|
|
<script type="text/javascript">
|
|
$(function(){initNavTree('_about.html','',''); });
|
|
</script>
|
|
<div id="container">
|
|
<div id="doc-content">
|
|
<!-- window showing the filter options -->
|
|
<div id="MSearchSelectWindow"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
|
</div>
|
|
|
|
<!-- iframe showing the search results (closed by default) -->
|
|
<div id="MSearchResultsWindow">
|
|
<div id="MSearchResults">
|
|
<div class="SRPage">
|
|
<div id="SRIndex">
|
|
<div id="SRResults"></div>
|
|
<div class="SRStatus" id="Loading">Loading...</div>
|
|
<div class="SRStatus" id="Searching">Searching...</div>
|
|
<div class="SRStatus" id="NoMatches">No Matches</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
<div><div class="header">
|
|
<div class="headertitle"><div class="title">About </div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<div class="textblock"><p>Navigate back: <a class="el" href="index.html" title="notitle">Main</a> </p><hr />
|
|
<h1 class="doxsection"><a class="anchor" id="about_history"></a>
|
|
History</h1>
|
|
<p>The implementation of this documentation set is based on the fantastic work of the <a href="https://eigen.tuxfamily.org/index.php?title=Main_Page">Eigen project</a>. Please refer to their <a href="https://gitlab.com/libeigen/eigen">GitLab repository</a> and the online version of their <a href="http://eigen.tuxfamily.org/dox/">Doxygen-based documentation</a>. Not only does Eigen set a standard as a piece of software, but also as an example of <em>documentation done right</em>. And kudos to the <a href="https://github.com/jothepro/doxygen-awesome-css">Doxygen Awesome project</a> for their style sheets.</p>
|
|
<h1 class="doxsection"><a class="anchor" id="about_documentation"></a>
|
|
Documentation about Documentation</h1>
|
|
<p>In this section, we describe common documentation maintenance tasks.</p>
|
|
<h2 class="doxsection"><a class="anchor" id="plain_html"></a>
|
|
Including Plain HTML Pages</h2>
|
|
<p>The most common use case for this is the inclusion of older documentation. New documentation should, whenever possible, be created using Doxygen markdown!</p>
|
|
<p>Use Doxygen's <a href="https://www.doxygen.nl/manual/commands.html#cmdhtmlinclude"><code>htmlinclude</code></a> special command to include existing plain HTML pages.</p>
|
|
<h2 class="doxsection"><a class="anchor" id="new_rm_entry"></a>
|
|
Creating a New Reference Manual Entry</h2>
|
|
<p>Please refer to the <a class="el" href="_r_m_t.html" title="Reference Manual (RM) Page Template">Reference Manual (RM) Page Template</a> for guidance on how to create a new reference manual entry.</p>
|
|
<h3 class="doxsection"><a class="anchor" id="new_example"></a>
|
|
Adding and Referencing API Examples</h3>
|
|
<p>For each HDF5 module, such as <span class="tt"><a class="el" href="group___h5_f.html">Files (H5F)</a></span>, there is an examples source file called <span class="tt">H5*_examples.c</span>. For example, the <span class="tt"><a class="el" href="group___h5_f.html">Files (H5F)</a></span> API examples are located in <a href="https://github.com/HDFGroup/hdf5/blob/develop/doxygen/examples/H5F_examples.c"><code>H5F_examples.c</code></a>. Examples are code blocks marked as Doxygen <a href="https://www.doxygen.nl/manual/commands.html#cmdsnippet">snippets</a>. For example, the source code for the <a class="el" href="group___h5_f.html#gae64b51ee9ac0781bc4ccc599d98387f4" title="Creates an HDF5 file.">H5Fcreate()</a> API sample is located between the </p><pre class="fragment">//! <!-- [create] -->
|
|
...
|
|
//! <!-- [create] -->
|
|
</pre><p> comments in <a href="https://github.com/HDFGroup/hdf5/blob/develop/doxygen/examples/H5F_examples.c"><code>H5F_examples.c</code></a>.</p>
|
|
<p>Add a new API example by adding a new code block enclosed between matching snippet tags. The name of the tag is usually the function name stripped of the module prefix.</p>
|
|
<p>The inclusion of such a block of code can then be triggered via Doxygen's <a href="https://www.doxygen.nl/manual/commands.html#cmdsnippet"><code>snippet</code></a> special command. For example, the following markup </p><pre class="fragment">* \snippet H5F_examples.c create
|
|
</pre><p> yields </p><div class="fragment"><div class="line"> {</div>
|
|
<div class="line"> __label__ fail_fapl, fail_fcpl, fail_file;</div>
|
|
<div class="line"> <a class="code hl_typedef" href="_h5_ipublic_8h.html#a0045db7ff9c22ad35db6ae91662e1943">hid_t</a> fcpl, fapl, file;</div>
|
|
<div class="line"> </div>
|
|
<div class="line"> <span class="keywordflow">if</span> ((fcpl = <a class="code hl_function" href="group___p_l_c_r.html#gaf1b11da01d4d45d788c45f8bc5f0cbfa">H5Pcreate</a>(<a class="code hl_define" href="_h5_ppublic_8h.html#a206f334f1e6c973e1215a3148b45b977">H5P_FILE_CREATE</a>)) == <a class="code hl_define" href="_h5_ipublic_8h.html#a01eab13dccc91afd6909d74dccb780ba">H5I_INVALID_HID</a>) {</div>
|
|
<div class="line"> ret_val = EXIT_FAILURE;</div>
|
|
<div class="line"> <span class="keywordflow">goto</span> fail_fcpl;</div>
|
|
<div class="line"> }</div>
|
|
<div class="line"> <span class="keywordflow">else</span> {</div>
|
|
<div class="line"> <span class="comment">// adjust the file creation properties</span></div>
|
|
<div class="line"> }</div>
|
|
<div class="line"> </div>
|
|
<div class="line"> <span class="keywordflow">if</span> ((fapl = <a class="code hl_function" href="group___p_l_c_r.html#gaf1b11da01d4d45d788c45f8bc5f0cbfa">H5Pcreate</a>(<a class="code hl_define" href="_h5_ppublic_8h.html#a60ec2d4334addfc0eda89614598ee38e">H5P_FILE_ACCESS</a>)) == <a class="code hl_define" href="_h5_ipublic_8h.html#a01eab13dccc91afd6909d74dccb780ba">H5I_INVALID_HID</a>) {</div>
|
|
<div class="line"> ret_val = EXIT_FAILURE;</div>
|
|
<div class="line"> <span class="keywordflow">goto</span> fail_fapl;</div>
|
|
<div class="line"> }</div>
|
|
<div class="line"> <span class="keywordflow">else</span> {</div>
|
|
<div class="line"> <span class="comment">// adjust the file access properties</span></div>
|
|
<div class="line"> }</div>
|
|
<div class="line"> </div>
|
|
<div class="line"> <span class="keywordtype">unsigned</span> mode = <a class="code hl_define" href="_h5_fpublic_8h.html#a7a47250dc1435705233dca7297ba3d90">H5F_ACC_EXCL</a>;</div>
|
|
<div class="line"> <span class="keywordtype">char</span> name[] = <span class="stringliteral">"f1.h5"</span>;</div>
|
|
<div class="line"> </div>
|
|
<div class="line"> <span class="keywordflow">if</span> ((file = <a class="code hl_function" href="group___h5_f.html#gae64b51ee9ac0781bc4ccc599d98387f4">H5Fcreate</a>(name, mode, fcpl, fapl)) == <a class="code hl_define" href="_h5_ipublic_8h.html#a01eab13dccc91afd6909d74dccb780ba">H5I_INVALID_HID</a>) {</div>
|
|
<div class="line"> ret_val = EXIT_FAILURE;</div>
|
|
<div class="line"> <span class="keywordflow">goto</span> fail_file;</div>
|
|
<div class="line"> }</div>
|
|
<div class="line"> </div>
|
|
<div class="line"> <span class="comment">// do something useful with FILE</span></div>
|
|
<div class="line"> </div>
|
|
<div class="line"> <a class="code hl_function" href="group___h5_f.html#gac55cd91d80822e4f8c2a7f04ea71b124">H5Fclose</a>(file);</div>
|
|
<div class="line">fail_file:</div>
|
|
<div class="line"> <a class="code hl_function" href="group___p_l_c_r.html#ga5dce61149211d3ef319452aa598887fb">H5Pclose</a>(fapl);</div>
|
|
<div class="line">fail_fapl:</div>
|
|
<div class="line"> <a class="code hl_function" href="group___p_l_c_r.html#ga5dce61149211d3ef319452aa598887fb">H5Pclose</a>(fcpl);</div>
|
|
<div class="line">fail_fcpl:;</div>
|
|
<div class="line"> }</div>
|
|
</div><!-- fragment --><h3 class="doxsection"><a class="anchor" id="api_macro"></a>
|
|
Adding an API Macro</h3>
|
|
<p>API macros are handled by the <code>api_vers_2, api_vers_3, api_vers_4</code> custom commands. The numbers indicate the number of potential API function mappings. For example, <a class="el" href="group___h5_a.html#ga4a76e4e5ab6eb0fd2aa7990d38d55f24">H5Acreate()</a> has two potential mappings, <a class="el" href="group___h5_a.html#gaa30f5f6c277d6c46f8aa31e89cdba085" title="Creates an attribute attached to a specified object.">H5Acreate1()</a> and <a class="el" href="group___h5_a.html#ga4f4e5248c09f689633079ed8afc0b308" title="Creates an attribute attached to a specified object.">H5Acreate2()</a>. To trigger the creation of a reference manual entry for <a class="el" href="group___h5_a.html#ga4a76e4e5ab6eb0fd2aa7990d38d55f24">H5Acreate()</a> use the following markup: </p><pre class="fragment">\api_vers_2{H5Acreate,H5Acreate1,H5Acreate2}
|
|
</pre><p> This yields:</p>
|
|
<p><a class="el" href="group___h5_a.html#ga4a76e4e5ab6eb0fd2aa7990d38d55f24">H5Acreate()</a> is a macro that is mapped to either <a class="el" href="group___h5_a.html#gaa30f5f6c277d6c46f8aa31e89cdba085" title="Creates an attribute attached to a specified object.">H5Acreate1()</a> or <a class="el" href="group___h5_a.html#ga4f4e5248c09f689633079ed8afc0b308" title="Creates an attribute attached to a specified object.">H5Acreate2()</a>.<br />
|
|
</p><dl class="section see"><dt>See also</dt><dd><a class="el" href="api-compat-macros.html" title="API Compatibility Macros">API Compatibility Macros</a></dd></dl>
|
|
<h2 class="doxsection"><a class="anchor" id="custom_commands"></a>
|
|
Creating Custom Commands</h2>
|
|
<p>See Doxygen's <a href="https://www.doxygen.nl/manual/custcmd.html">Custom Commands documentation</a> as a general reference.</p>
|
|
<p>All custom commands for this project are located in the <a href="https://github.com/HDFGroup/hdf5/blob/develop/doxygen/aliases"><span class="tt">aliases</span></a> file in the <a href="https://github.com/HDFGroup/hdf5/blob/develop/doxygen"><span class="tt">doxygen</span></a> subdirectory of the <a href="https://github.com/HDFGroup/hdf5">main HDF5 repo</a>.</p>
|
|
<p>The custom commands are grouped in sections. Find a suitable section for your command or ask for help if unsure!</p>
|
|
<h2 class="doxsection"><a class="anchor" id="new_rfc"></a>
|
|
Adding a New RFC or Referencing an Existing RFC</h2>
|
|
<p>For ease of reference, we define custom commands for each RFC in the <span class="tt">RFCs</span> section of the <a href="https://github.com/HDFGroup/hdf5/blob/develop/doxygen/aliases"><span class="tt">aliases</span></a> file. For example the custom command <span class="tt">ref_rfc20141210</span> can be used to insert a reference to "RFC: Virtual Object Layer". In other words, the markup </p><pre class="fragment">\ref_rfc20141210
|
|
</pre><p> yields a clickable link:</p>
|
|
<p><a href="https://support.hdfgroup.org/releases/hdf5/documentation/rfc/HDF5-VDS-requirements-use-cases-2014-12-10.pdf">HDF5 Virtual Dataset</a></p>
|
|
<p>To add a new RFC, add a custom command for the RFC to the <a href="https://github.com/HDFGroup/hdf5/blob/develop/doxygen/aliases"><span class="tt">aliases</span></a> file. The naming convention for the custom command is <span class="tt">ref_rfcYYYYMMDD</span>, where <span class="tt">YYYYMMDD</span> is the ID of the RFC. The URL is composed of the prefix </p><pre class="fragment">https://\RFCURL/
|
|
</pre><p> and the name of your RFC file, typically, a PDF file, i.e., the full URL would be </p><pre class="fragment">https://\RFCURL/my_great_rfc_name.pdf
|
|
</pre><hr />
|
|
<p> Navigate back: <a class="el" href="index.html" title="notitle">Main</a> </p>
|
|
</div></div><!-- contents -->
|
|
</div><!-- PageDoc -->
|
|
</div><!-- doc-content -->
|
|
<div id="page-nav" class="page-nav-panel">
|
|
<div id="page-nav-resize-handle"></div>
|
|
<div id="page-nav-tree">
|
|
<div id="page-nav-contents">
|
|
</div><!-- page-nav-contents -->
|
|
</div><!-- page-nav-tree -->
|
|
</div><!-- page-nav -->
|
|
</div><!-- container -->
|
|
<!-- start footer part -->
|
|
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
|
|
<ul>
|
|
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.16.1 </li>
|
|
</ul>
|
|
</div>
|
|
</body>
|
|
</html>
|