diff options
| author | Don Turner <donturner@google.com> | 2018-09-10 17:56:59 +0100 |
|---|---|---|
| committer | Don Turner <donturner@google.com> | 2018-09-10 17:56:59 +0100 |
| commit | 6f3d6cd6c8bdf70dda4f5cff3225881a3bc95dc0 (patch) | |
| tree | 8abaf6749ae7b8af0e369d8bd483529af1ed20aa /docs/reference/a00064.html | |
| parent | a180fac9923e8fda2739282541bb0c54f97a31fe (diff) | |
| download | oboe-6f3d6cd6c8bdf70dda4f5cff3225881a3bc95dc0.tar.gz | |
Use SHORT_NAMES to see if this solves Jekyll build error
Diffstat (limited to 'docs/reference/a00064.html')
| -rw-r--r-- | docs/reference/a00064.html | 218 |
1 files changed, 218 insertions, 0 deletions
diff --git a/docs/reference/a00064.html b/docs/reference/a00064.html new file mode 100644 index 00000000..324b678a --- /dev/null +++ b/docs/reference/a00064.html @@ -0,0 +1,218 @@ +<!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.8.14"/> +<meta name="viewport" content="width=device-width, initial-scale=1"/> +<title>Oboe: oboe::Version Struct Reference</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="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> +<link href="doxygen.css" rel="stylesheet" type="text/css" /> +</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 style="height: 56px;"> + <td id="projectalign" style="padding-left: 0.5em;"> + <div id="projectname">Oboe +  <span id="projectnumber">1.0</span> + </div> + <div id="projectbrief">Audio library for Android</div> + </td> + </tr> + </tbody> +</table> +</div> +<!-- end header part --> +<!-- Generated by Doxygen 1.8.14 --> +<script type="text/javascript"> +/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ +var searchBox = new SearchBox("searchBox", "search",false,'Search'); +/* @license-end */ +</script> +<script type="text/javascript" src="menudata.js"></script> +<script type="text/javascript" src="menu.js"></script> +<script type="text/javascript"> +/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ +$(function() { + initMenu('',true,false,'search.php','Search'); + $(document).ready(function() { init_search(); }); +}); +/* @license-end */</script> +<div id="main-nav"></div> +<!-- 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 id="nav-path" class="navpath"> + <ul> +<li class="navelem"><a class="el" href="a00032.html">oboe</a></li><li class="navelem"><a class="el" href="a00064.html">Version</a></li> </ul> +</div> +</div><!-- top --> +<div class="header"> + <div class="summary"> +<a href="#pub-static-attribs">Static Public Attributes</a> | +<a href="a00061.html">List of all members</a> </div> + <div class="headertitle"> +<div class="title">oboe::Version Struct Reference</div> </div> +</div><!--header--> +<div class="contents"> +<table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-attribs"></a> +Static Public Attributes</h2></td></tr> +<tr class="memitem:a270f2e92582d5187be339eeda8e2b276"><td class="memItemLeft" align="right" valign="top">static constexpr uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="a00064.html#a270f2e92582d5187be339eeda8e2b276">Major</a> = OBOE_VERSION_MAJOR</td></tr> +<tr class="separator:a270f2e92582d5187be339eeda8e2b276"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ae460bb95e3a9099696205a35fffb5469"><td class="memItemLeft" align="right" valign="top">static constexpr uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="a00064.html#ae460bb95e3a9099696205a35fffb5469">Minor</a> = OBOE_VERSION_MINOR</td></tr> +<tr class="separator:ae460bb95e3a9099696205a35fffb5469"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a690110f2b3e887892da8f29ab5c057b2"><td class="memItemLeft" align="right" valign="top">static constexpr uint16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="a00064.html#a690110f2b3e887892da8f29ab5c057b2">Patch</a> = OBOE_VERSION_PATCH</td></tr> +<tr class="separator:a690110f2b3e887892da8f29ab5c057b2"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a2c86e578b827fbca5f40c460a7754503"><td class="memItemLeft" align="right" valign="top">static constexpr const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00064.html#a2c86e578b827fbca5f40c460a7754503">Text</a> = OBOE_VERSION_TEXT</td></tr> +<tr class="separator:a2c86e578b827fbca5f40c460a7754503"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ac579661e79bcee45dc676d4647891de0"><td class="memItemLeft" align="right" valign="top">static constexpr uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="a00064.html#ac579661e79bcee45dc676d4647891de0">Number</a> = OBOE_VERSION_NUMBER</td></tr> +<tr class="separator:ac579661e79bcee45dc676d4647891de0"><td class="memSeparator" colspan="2"> </td></tr> +</table> +<h2 class="groupheader">Member Data Documentation</h2> +<a id="a270f2e92582d5187be339eeda8e2b276"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a270f2e92582d5187be339eeda8e2b276">◆ </a></span>Major</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">constexpr uint8_t oboe::Version::Major = OBOE_VERSION_MAJOR</td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">static</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> +<p>This is incremented when we make breaking API changes. Based loosely on <a href="https://semver.org/">https://semver.org/</a>. </p> + +</div> +</div> +<a id="ae460bb95e3a9099696205a35fffb5469"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ae460bb95e3a9099696205a35fffb5469">◆ </a></span>Minor</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">constexpr uint8_t oboe::Version::Minor = OBOE_VERSION_MINOR</td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">static</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> +<p>This is incremented when we add backwards compatible functionality. Or set to zero when MAJOR is incremented. </p> + +</div> +</div> +<a id="ac579661e79bcee45dc676d4647891de0"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ac579661e79bcee45dc676d4647891de0">◆ </a></span>Number</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">constexpr uint32_t oboe::Version::Number = OBOE_VERSION_NUMBER</td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">static</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> +<p>Integer representation of the current Oboe library version. This will always increase when the version number changes so can be compared using integer comparison. </p> + +</div> +</div> +<a id="a690110f2b3e887892da8f29ab5c057b2"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a690110f2b3e887892da8f29ab5c057b2">◆ </a></span>Patch</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">constexpr uint16_t oboe::Version::Patch = OBOE_VERSION_PATCH</td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">static</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> +<p>This is incremented when we make backwards compatible bug fixes. Or set to zero when MINOR is incremented. </p> + +</div> +</div> +<a id="a2c86e578b827fbca5f40c460a7754503"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a2c86e578b827fbca5f40c460a7754503">◆ </a></span>Text</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">constexpr const char* oboe::Version::Text = OBOE_VERSION_TEXT</td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">static</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> +<p><a class="el" href="a00064.html">Version</a> string in the form MAJOR.MINOR.PATCH. </p> + +</div> +</div> +<hr/>The documentation for this struct was generated from the following file:<ul> +<li>include/oboe/<a class="el" href="a00029_source.html">Version.h</a></li> +</ul> +</div><!-- contents --> +<!-- start footer part --> +<hr class="footer"/><address class="footer"><small> +Generated by  <a href="http://www.doxygen.org/index.html"> +<img class="footer" src="doxygen.png" alt="doxygen"/> +</a> 1.8.14 +</small></address> +</body> +</html> |