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.6"/>
   7 <title>yaml: Version Information</title>
   8 <link href="tabs.css" rel="stylesheet" type="text/css"/>
   9 <script type="text/javascript" src="jquery.js"></script>
  10 <script type="text/javascript" src="dynsections.js"></script>
  11 <link href="doxygen.css" rel="stylesheet" type="text/css" />
  12 </head>
  13 <body>
  14 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  15 <div id="titlearea">
  16 <table cellspacing="0" cellpadding="0">
  17  <tbody>
  18  <tr style="height: 56px;">
  19   <td style="padding-left: 0.5em;">
  20    <div id="projectname">yaml
  21    &#160;<span id="projectnumber">0.1.7</span>
  22    </div>
  23   </td>
  24  </tr>
  25  </tbody>
  26 </table>
  27 </div>
  28 <!-- end header part -->
  29 <!-- Generated by Doxygen 1.8.6 -->
  30   <div id="navrow1" class="tabs">
  31     <ul class="tablist">
  32       <li><a href="index.html"><span>Main&#160;Page</span></a></li>
  33       <li><a href="modules.html"><span>Modules</span></a></li>
  34       <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
  35       <li><a href="files.html"><span>Files</span></a></li>
  36     </ul>
  37   </div>
  38 </div><!-- top -->
  39 <div class="header">
  40   <div class="summary">
  41 <a href="#func-members">Functions</a>  </div>
  42   <div class="headertitle">
  43 <div class="title">Version Information</div>  </div>
  44 </div><!--header-->
  45 <div class="contents">
  46 <table class="memberdecls">
  47 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
  48 Functions</h2></td></tr>
  49 <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>
  50 <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>
  51 <tr class="separator:gaf1ba5c1c34e809db5047d79a9fa85a73"><td class="memSeparator" colspan="2">&#160;</td></tr>
  52 <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>
  53 <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>
  54 <tr class="separator:gaec764c91f3e181ae63d3d59b7980fe78"><td class="memSeparator" colspan="2">&#160;</td></tr>
  55 </table>
  56 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  57 <h2 class="groupheader">Function Documentation</h2>
  58 <a class="anchor" id="gaf1ba5c1c34e809db5047d79a9fa85a73"></a>
  59 <div class="memitem">
  60 <div class="memproto">
  61       <table class="memname">
  62         <tr>
  63           <td class="memname">const char* yaml_get_version_string </td>
  64           <td>(</td>
  65           <td class="paramtype">void&#160;</td>
  66           <td class="paramname"></td><td>)</td>
  67           <td></td>
  68         </tr>
  69       </table>
  70 </div><div class="memdoc">
  71
  72 <p>Get the library version as a string. </p>
  73 <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>
  74
  75 </div>
  76 </div>
  77 <a class="anchor" id="gaec764c91f3e181ae63d3d59b7980fe78"></a>
  78 <div class="memitem">
  79 <div class="memproto">
  80       <table class="memname">
  81         <tr>
  82           <td class="memname">void yaml_get_version </td>
  83           <td>(</td>
  84           <td class="paramtype">int *&#160;</td>
  85           <td class="paramname"><em>major</em>, </td>
  86         </tr>
  87         <tr>
  88           <td class="paramkey"></td>
  89           <td></td>
  90           <td class="paramtype">int *&#160;</td>
  91           <td class="paramname"><em>minor</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>patch</em>&#160;</td>
  98         </tr>
  99         <tr>
 100           <td></td>
 101           <td>)</td>
 102           <td></td><td></td>
 103         </tr>
 104       </table>
 105 </div><div class="memdoc">
 106
 107 <p>Get the library version numbers. </p>
 108 <dl class="params"><dt>Parameters</dt><dd>
 109   <table class="params">
 110     <tr><td class="paramdir">[out]</td><td class="paramname">major</td><td>Major version number. </td></tr>
 111     <tr><td class="paramdir">[out]</td><td class="paramname">minor</td><td>Minor version number. </td></tr>
 112     <tr><td class="paramdir">[out]</td><td class="paramname">patch</td><td>Patch version number. </td></tr>
 113   </table>
 114   </dd>
 115 </dl>
 116
 117 </div>
 118 </div>
 119 </div><!-- contents -->
 120 <!-- start footer part -->
 121 <hr class="footer"/><address class="footer"><small>
 122 Generated on Sun Aug 28 2016 23:56:54 for yaml by &#160;<a href="http://www.doxygen.org/index.html">
 123 <img class="footer" src="doxygen.png" alt="doxygen"/>
 124 </a> 1.8.6
 125 </small></address>
 126 </body>
 127 </html>