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