docs/reference/libnice/html/annotation-glossary.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
   2 <html>
   3 <head>
   4 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
   5 <title>Annotation Glossary: libnice Reference Manual</title>
   6 <meta name="generator" content="DocBook XSL Stylesheets Vsnapshot">
   7 <link rel="home" href="index.html" title="libnice Reference Manual">
   8 <link rel="up" href="pt04.html" title="Part IV. Appendices">
   9 <link rel="prev" href="ix15.html" title="Index of new symbols in 0.1.16">
  10 <meta name="generator" content="GTK-Doc V1.29 (XML mode)">
  11 <link rel="stylesheet" href="style.css" type="text/css">
  12 </head>
  13 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
  14 <table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
  15 <td width="100%" align="left" class="shortcuts"><span id="nav_glossary"><a class="shortcut" href="#glsA">A</a>
  16                      <span class="dim">|</span>
  17                   <a class="shortcut" href="#glsE">E</a>
  18                      <span class="dim">|</span>
  19                   <a class="shortcut" href="#glsI">I</a>
  20                      <span class="dim">|</span>
  21                   <a class="shortcut" href="#glsN">N</a>
  22                      <span class="dim">|</span>
  23                   <a class="shortcut" href="#glsO">O</a>
  24                      <span class="dim">|</span>
  25                   <a class="shortcut" href="#glsS">S</a>
  26                      <span class="dim">|</span>
  27                   <a class="shortcut" href="#glsT">T</a>
  28                      <span class="dim">|</span>
  29                   <a class="shortcut" href="#glsU">U</a></span></td>
  30 <td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
  31 <td><a accesskey="u" href="pt04.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
  32 <td><a accesskey="p" href="ix15.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
  33 <td><img src="right-insensitive.png" width="16" height="16" border="0"></td>
  34 </tr></table>
  35 <div class="glossary">
  36 <div class="titlepage"><div><div><h2 class="title">
  37 <a name="annotation-glossary"></a>Annotation Glossary</h2></div></div></div>
  38 <a name="glsA"></a><h3 class="title">A</h3>
  39 <dt><span class="glossterm"><a name="annotation-glossterm-allow-none"></a>allow-none</span></dt>
  40 <dd class="glossdef"><p>NULL is OK, both for passing and for returning.</p></dd>
  41 <dt><span class="glossterm"><a name="annotation-glossterm-array"></a>array</span></dt>
  42 <dd class="glossdef"><p>Parameter points to an array of items.</p></dd>
  43 <a name="glsE"></a><h3 class="title">E</h3>
  44 <dt><span class="glossterm"><a name="annotation-glossterm-element-type"></a>element-type</span></dt>
  45 <dd class="glossdef"><p>Generics and defining elements of containers and arrays.</p></dd>
  46 <a name="glsI"></a><h3 class="title">I</h3>
  47 <dt><span class="glossterm"><a name="annotation-glossterm-in"></a>in</span></dt>
  48 <dd class="glossdef"><p>Parameter for input. Default is <acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>.</p></dd>
  49 <a name="glsN"></a><h3 class="title">N</h3>
  50 <dt><span class="glossterm"><a name="annotation-glossterm-nullable"></a>nullable</span></dt>
  51 <dd class="glossdef"><p>NULL may be passed as the value in, out, in-out; or as a return value.</p></dd>
  52 <a name="glsO"></a><h3 class="title">O</h3>
  53 <dt><span class="glossterm"><a name="annotation-glossterm-out%20callee-allocates"></a>out callee-allocates</span></dt>
  54 <dd class="glossdef"><p>Out parameter, where caller must allocate storage.</p></dd>
  55 <dt><span class="glossterm"><a name="annotation-glossterm-out%20caller-allocates"></a>out caller-allocates</span></dt>
  56 <dd class="glossdef"><p>Out parameter, where caller must allocate storage.</p></dd>
  57 <a name="glsS"></a><h3 class="title">S</h3>
  58 <dt><span class="glossterm"><a name="annotation-glossterm-skip"></a>skip</span></dt>
  59 <dd class="glossdef"><p>Exposed in C code, not necessarily available in other languages.</p></dd>
  60 <dt><span class="glossterm"><a name="annotation-glossterm-Stable"></a>Stable</span></dt>
  61 <dd class="glossdef"><p>The intention of a Stable interface is to enable arbitrary third parties to
  62 develop applications to these interfaces, release them, and have confidence that
  63 they will run on all minor releases of the product (after the one in which the
  64 interface was introduced, and within the same major release). Even at a major
  65 release, incompatible changes are expected to be rare, and to have strong
  66 justifications.
  67 </p></dd>
  68 <a name="glsT"></a><h3 class="title">T</h3>
  69 <dt><span class="glossterm"><a name="annotation-glossterm-transfer%20full"></a>transfer full</span></dt>
  70 <dd class="glossdef"><p>Free data after the code is done.</p></dd>
  71 <dt><span class="glossterm"><a name="annotation-glossterm-transfer%20none"></a>transfer none</span></dt>
  72 <dd class="glossdef"><p>Don't free data after the code is done.</p></dd>
  73 <a name="glsU"></a><h3 class="title">U</h3>
  74 <dt><span class="glossterm"><a name="annotation-glossterm-Unstable"></a>Unstable</span></dt>
  75 <dd class="glossdef"><p>Unstable interfaces are experimental or transitional. They are typically used to
  76 give outside developers early access to new or rapidly changing technology, or
  77 to provide an interim solution to a problem where a more general solution is
  78 anticipated. No claims are made about either source or binary compatibility from
  79 one minor release to the next.
  80
  81 The Unstable interface level is a warning that these interfaces are  subject to
  82 change without warning and should not be used in unbundled products.
  83
  84 Given such caveats, customer impact need not be a factor when considering
  85 incompatible changes to an Unstable interface in a major or minor release.
  86 Nonetheless, when such changes are introduced, the changes should still be
  87 mentioned in the release notes for the affected release.
  88 </p></dd>
  89 </div>
  90 <div class="footer">
  91 <hr>Generated by GTK-Doc V1.29</div>
  92 </body>
  93 </html>