summaryrefslogtreecommitdiffstats
path: root/develop/_r_m_t.html
diff options
context:
space:
mode:
authorbyrnHDF <byrnHDF@users.noreply.github.com>2023-11-16 13:49:28 (GMT)
committerbyrnHDF <byrnHDF@users.noreply.github.com>2023-11-16 13:49:28 (GMT)
commit4f20d880c97be1249f8d89ced95f72836dbf3ee0 (patch)
tree30d8dcb282134b7126b092796f2be00d2d97bd3c /develop/_r_m_t.html
parent4e7e457497c948b41c8b0065225875bf10cdf9d4 (diff)
downloadhdf5-4f20d880c97be1249f8d89ced95f72836dbf3ee0.zip
hdf5-4f20d880c97be1249f8d89ced95f72836dbf3ee0.tar.gz
hdf5-4f20d880c97be1249f8d89ced95f72836dbf3ee0.tar.bz2
deploy: ef39882fa1e13740d2530c7a0637bd1f1a822b68
Diffstat (limited to 'develop/_r_m_t.html')
-rw-r--r--develop/_r_m_t.html185
1 files changed, 185 insertions, 0 deletions
diff --git a/develop/_r_m_t.html b/develop/_r_m_t.html
new file mode 100644
index 0000000..0e678ee
--- /dev/null
+++ b/develop/_r_m_t.html
@@ -0,0 +1,185 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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=9"/>
+<meta name="generator" content="Doxygen 1.9.1"/>
+<meta name="viewport" content="width=device-width, initial-scale=1"/>
+<title>HDF5: Reference Manual (RM) Page Template</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="resize.js"></script>
+<script type="text/javascript" src="navtreedata.js"></script>
+<script type="text/javascript" src="navtree.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">
+/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
+ $(document).ready(function() { init_search(); });
+/* @license-end */
+</script>
+<link href="doxygen.css" rel="stylesheet" type="text/css" />
+<link href="hdf5doxy.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>
+</head>
+<body>
+<div style="background:#FFDDDD;font-size:120%;text-align:center;margin:0;padding:5px">Please, help us to better serve our user community by answering the following short survey: <a href="https://www.hdfgroup.org/website-survey/">https://www.hdfgroup.org/website-survey/</a></div>
+<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
+<div id="titlearea">
+<table cellspacing="0" cellpadding="0">
+ <tbody>
+ <tr style="height: 56px;">
+ <td id="projectlogo"><img alt="Logo" src="HDFG-logo.png"/></td>
+ <td id="projectalign" style="padding-left: 0.5em;">
+ <div id="projectname"><a href="https://www.hdfgroup.org">HDF5</a>
+ &#160;<span id="projectnumber">1.15.0.ef39882</span>
+ </div>
+ <div id="projectbrief">API Reference</div>
+ </td>
+ <td> <div id="MSearchBox" class="MSearchBoxInactive">
+ <span class="left">
+ <img id="MSearchSelect" src="search/mag_sel.svg"
+ onmouseover="return searchBox.OnSearchSelectShow()"
+ onmouseout="return searchBox.OnSearchSelectHide()"
+ alt=""/>
+ <input type="text" id="MSearchField" value="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()"><img id="MSearchCloseImg" border="0" src="search/close.svg" alt=""/></a>
+ </span>
+ </div>
+</td>
+ </tr>
+ </tbody>
+</table>
+</div>
+<!-- end header part -->
+<!-- Generated by Doxygen 1.9.1 -->
+<script type="text/javascript">
+/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
+var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
+/* @license-end */
+</script>
+</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">
+/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
+$(document).ready(function(){initNavTree('_r_m_t.html',''); initResizable(); });
+/* @license-end */
+</script>
+<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">
+<iframe src="javascript:void(0)" frameborder="0"
+ name="MSearchResults" id="MSearchResults">
+</iframe>
+</div>
+
+<div class="PageDoc"><div class="header">
+ <div class="headertitle">
+<div class="title">Reference Manual (RM) Page Template </div> </div>
+</div><!--header-->
+<div class="contents">
+<div class="textblock"><p>We treat documentation like code and use <a href="https://www.doxygen.nl/index.html">Doxygen</a> to <a href="https://github.com/HDFGroup/hdf5/blob/develop/src/H5Fpublic.h">markup comments in the code</a> or create <a href="https://github.com/HDFGroup/hdf5/blob/develop/doxygen/dox/Overview.dox">stand-alone pages</a>.</p>
+<p>Every RM entry consists of a subset of the elements listed below. Not every RM entry warrants the full set. More is better, and we can, perhaps, distinguish minimal, typical, and great RM entries.</p>
+<p>A minimal RM entry must include elements 1-3, 8, 11, and 7 if applicable.</p>
+<p>A <em>typical</em> RM entry is a minimal RM entry that in addition has elements 9, 10, and 12.</p>
+<p>A <b>great</b> RM entry is a typical RM entry plus everything else.</p>
+<p>The current RM is a mixed bag. Take what's there with a pinch of salt and apply the <a href="https://www.oreilly.com/library/view/97-things-every/9780596809515/ch08.html">Scout Rule</a>!</p>
+<dl class="section user"><dt>RM entry elements</dt><dd></dd></dl>
+<ol type="1">
+<li>Module indication<ul>
+<li>Indicate the HDF5 module in which the function will appear. <pre class="fragment"> * \ingroup H5XYZ</pre></li>
+</ul>
+</li>
+<li>Synopsis<ul>
+<li>A phrase or sentence that summarizes the function's purpose <pre class="fragment"> * \brief Simplifies your life</pre></li>
+</ul>
+</li>
+<li>Prototype (parameters and return value)<ul>
+<li>A description of the function parameters and return value <pre class="fragment"> * \param[in] name1 Description of IN parameter \p name1
+ * \param[out] name2 Description of OUT parameter \p name2
+ * \param[in,out] name3 Description of INOUT parameter \p name3
+ * \return Returns what you always wanted</pre></li>
+<li>Clearly indicate the parameter direction as <code>in</code>, <code>out</code>, or <code>in,out</code></li>
+<li>Make reference to other parameters using <code>\p</code></li>
+</ul>
+</li>
+<li>Preconditions<ul>
+<li>A set of preconditions that must be met. <pre class="fragment"> * \pre The argument supplied in parameter \p name2 must be even.</pre></li>
+</ul>
+</li>
+<li>Invariants<ul>
+<li>A set of invariants. <pre class="fragment"> * \invariant The mouse pointer will always be visible.</pre></li>
+</ul>
+</li>
+<li>Postconditions<ul>
+<li>What will be true when the function returns. <pre class="fragment"> * \post On error, the output parameters will be unmodified.</pre></li>
+</ul>
+</li>
+<li>Deprecation note<ul>
+<li>If a function was deprecated, list the version in which the function was deprecated (below), why it was deprecated, and which function(s) succeed it. <pre class="fragment"> * \deprecated Deprecated in favor of another great function.</pre></li>
+</ul>
+</li>
+<li>Details<ul>
+<li>A detailed description of the function's behavior <pre class="fragment"> * \details This is the heart of the matter. Try to be helpful!</pre></li>
+</ul>
+</li>
+<li>Example<ul>
+<li>The function in context and action, usually a (Doxygen) snippet. <pre class="fragment"> * \par Example
+ * \snippet H5F_examples.c minimal</pre></li>
+</ul>
+</li>
+<li>Instruction (attention, note, warning)<ul>
+<li>Behaviors, features, side-effects, etc. the user should be aware of <pre class="fragment"> * \note Dear reader, ...
+ *
+ * \attention Colorless green ideas sleep furiously.
+ *
+ * \warning Don't do this at home!</pre></li>
+</ul>
+</li>
+<li>Since<ul>
+<li>The HDF5 library version in which the function was introduced <pre class="fragment"> * \since 1.MAJOR.MINOR</pre></li>
+</ul>
+</li>
+<li>Version<ul>
+<li>Use this element to record a deprecation version, a change in parameter types, changes in behavior, etc. <pre class="fragment"> * \version 1.MAJOR.MINOR Function was deprecated in this release</pre> </li>
+</ul>
+</li>
+</ol>
+</div></div><!-- contents -->
+</div><!-- PageDoc -->
+</div><!-- doc-content -->
+<!-- start footer part -->
+<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
+ <ul>
+ <li class="footer">Generated by
+ <a href="http://www.doxygen.org/index.html">
+ <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.9.1 </li>
+ </ul>
+</div>
+</body>
+</html>
generated by cgit v0.12 at 2024-07-07 14:50:24 (GMT)