doc/html/group__version.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   2 <html xmlns="http://www.w3.org/1999/xhtml">
   3 <head>
   4 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
   5 <meta http-equiv="X-UA-Compatible" content="IE=9"/>
   6 <meta name="generator" content="Doxygen 1.8.14"/>
   7 <meta name="viewport" content="width=device-width, initial-scale=1"/>
   8 <title>yaml: Version Information</title>
   9 <link href="tabs.css" rel="stylesheet" type="text/css"/>
  10 <script type="text/javascript" src="jquery.js"></script>
  11 <script type="text/javascript" src="dynsections.js"></script>
  12 <link href="doxygen.css" rel="stylesheet" type="text/css" />
  13 </head>
  14 <body>
  15 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  16 <div id="titlearea">
  17 <table cellspacing="0" cellpadding="0">
  18  <tbody>
  19  <tr style="height: 56px;">
  20   <td id="projectalign" style="padding-left: 0.5em;">
  21    <div id="projectname">yaml
  22    &#160;<span id="projectnumber">0.2.1</span>
  23    </div>
  24   </td>
  25  </tr>
  26  </tbody>
  27 </table>
  28 </div>
  29 <!-- end header part -->
  30 <!-- Generated by Doxygen 1.8.14 -->
  31 <script type="text/javascript" src="menudata.js"></script>
  32 <script type="text/javascript" src="menu.js"></script>
  33 <script type="text/javascript">
  34 /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
  35 $(function() {
  36   initMenu('',false,false,'search.php','Search');
  37 });
  38 /* @license-end */</script>
  39 <div id="main-nav"></div>
  40 </div><!-- top -->
  41 <div class="header">
  42   <div class="summary">
  43 <a href="#func-members">Functions</a>  </div>
  44   <div class="headertitle">
  45 <div class="title">Version Information</div>  </div>
  46 </div><!--header-->
  47 <div class="contents">
  48 <table class="memberdecls">
  49 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
  50 Functions</h2></td></tr>
  51 <tr class="memitem:gaf1ba5c1c34e809db5047d79a9fa85a73"><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__version.html#gaf1ba5c1c34e809db5047d79a9fa85a73">yaml_get_version_string</a> (void)</td></tr>
  52 <tr class="memdesc:gaf1ba5c1c34e809db5047d79a9fa85a73"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the library version as a string.  <a href="#gaf1ba5c1c34e809db5047d79a9fa85a73">More...</a><br /></td></tr>
  53 <tr class="separator:gaf1ba5c1c34e809db5047d79a9fa85a73"><td class="memSeparator" colspan="2">&#160;</td></tr>
  54 <tr class="memitem:gaec764c91f3e181ae63d3d59b7980fe78"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__version.html#gaec764c91f3e181ae63d3d59b7980fe78">yaml_get_version</a> (int *major, int *minor, int *patch)</td></tr>
  55 <tr class="memdesc:gaec764c91f3e181ae63d3d59b7980fe78"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the library version numbers.  <a href="#gaec764c91f3e181ae63d3d59b7980fe78">More...</a><br /></td></tr>
  56 <tr class="separator:gaec764c91f3e181ae63d3d59b7980fe78"><td class="memSeparator" colspan="2">&#160;</td></tr>
  57 </table>
  58 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  59 <h2 class="groupheader">Function Documentation</h2>
  60 <a id="gaf1ba5c1c34e809db5047d79a9fa85a73"></a>
  61 <h2 class="memtitle"><span class="permalink"><a href="#gaf1ba5c1c34e809db5047d79a9fa85a73">&#9670;&nbsp;</a></span>yaml_get_version_string()</h2>
  62
  63 <div class="memitem">
  64 <div class="memproto">
  65       <table class="memname">
  66         <tr>
  67           <td class="memname">const char* yaml_get_version_string </td>
  68           <td>(</td>
  69           <td class="paramtype">void&#160;</td>
  70           <td class="paramname"></td><td>)</td>
  71           <td></td>
  72         </tr>
  73       </table>
  74 </div><div class="memdoc">
  75
  76 <p>Get the library version as a string. </p>
  77 <dl class="section return"><dt>Returns</dt><dd>The function returns the pointer to a static string of the form <code>"X.Y.Z"</code>, where <code>X</code> is the major version number, <code>Y</code> is a minor version number, and <code>Z</code> is the patch version number. </dd></dl>
  78
  79 </div>
  80 </div>
  81 <a id="gaec764c91f3e181ae63d3d59b7980fe78"></a>
  82 <h2 class="memtitle"><span class="permalink"><a href="#gaec764c91f3e181ae63d3d59b7980fe78">&#9670;&nbsp;</a></span>yaml_get_version()</h2>
  83
  84 <div class="memitem">
  85 <div class="memproto">
  86       <table class="memname">
  87         <tr>
  88           <td class="memname">void yaml_get_version </td>
  89           <td>(</td>
  90           <td class="paramtype">int *&#160;</td>
  91           <td class="paramname"><em>major</em>, </td>
  92         </tr>
  93         <tr>
  94           <td class="paramkey"></td>
  95           <td></td>
  96           <td class="paramtype">int *&#160;</td>
  97           <td class="paramname"><em>minor</em>, </td>
  98         </tr>
  99         <tr>
 100           <td class="paramkey"></td>
 101           <td></td>
 102           <td class="paramtype">int *&#160;</td>
 103           <td class="paramname"><em>patch</em>&#160;</td>
 104         </tr>
 105         <tr>
 106           <td></td>
 107           <td>)</td>
 108           <td></td><td></td>
 109         </tr>
 110       </table>
 111 </div><div class="memdoc">
 112
 113 <p>Get the library version numbers. </p>
 114 <dl class="params"><dt>Parameters</dt><dd>
 115   <table class="params">
 116     <tr><td class="paramdir">[out]</td><td class="paramname">major</td><td>Major version number. </td></tr>
 117     <tr><td class="paramdir">[out]</td><td class="paramname">minor</td><td>Minor version number. </td></tr>
 118     <tr><td class="paramdir">[out]</td><td class="paramname">patch</td><td>Patch version number. </td></tr>
 119   </table>
 120   </dd>
 121 </dl>
 122
 123 </div>
 124 </div>
 125 </div><!-- contents -->
 126 <!-- start footer part -->
 127 <hr class="footer"/><address class="footer"><small>
 128 Generated by &#160;<a href="http://www.doxygen.org/index.html">
 129 <img class="footer" src="doxygen.png" alt="doxygen"/>
 130 </a> 1.8.14
 131 </small></address>
 132 </body>
 133 </html>