autodoc.git / modref / ex / _3A_3A / _annotations.html

version» Context lines:

autodoc.git/modref/ex/_3A_3A/_annotations.html:1: + <!doctype html> + <html> +  <head> +  <meta content="width=device-width, initial-scale=1" name="viewport"> +  <meta charset="utf-8"> +  <title>::_annotations() - Pike Reference Manual</title> +  <!-- 221--> +  <link rel='stylesheet' href='../../style.css'> +  <script src='../../site.js'></script> +  <script src='../../constants.js'></script> +  <script>PikeDoc.NO_DYNAMIC = true;</script> +  <style type='text/css'> + svg line { stroke:#343434; stroke-width:2; } + svg text { fill:#343434; } + svg a { fill:#0768b2; text-decoration: underline; } + </style>    -  +  </head> +  <body> +  <header> +  <div class="header"> +  <div id="version"><strong data-id="version"></strong></div> +  <button id="burger"> +  <span class="bar"></span> +  <span class="bar"></span> +  <span class="bar"></span> +  <span class="bar"></span> +  </button><!-- Hamburger icon --> +  <h1> +  <a href="http://pike.lysator.liu.se/" class="logo"> +  <span>Pike programming language</span> +  </a> +  </h1> +  </div> +  </header> +  <div id="page"> +  <div class="navbar"> +  <nav> +  <div class="inner" id="navbar"> +  <a href='../../index.html'><b class='top head'>Top</b></a> + <a href='../../ex/_3A_3A.html'><b class='head'>::</b></a> + <script></script> + <noscript> + <div class='sidebar'> + <a href='../../ex/_3A_3A/index.html'><b>Symbol index</b></a><br /> + </div> + </noscript> +  +  </div> +  </nav> +  </div> +  <div class="content"> +  <div class="navbox"> +  <nav> +  <div class="sidebar"> +  <a href="../../ex/_3A_3A.html" class="prev"><span>&#10148;</span> ::</a> +  <a href="../../ex/_3A_3A/_types.html" class="next">::_types() <span>&#10148;</span></a> +  </div> +  </nav> +  </div> +  <div class="contentbox"> +  <article> +  <h1>Method ::_annotations()</h1> +  +  + <hr /> + <dl class='group--doc'> + <dt class='head--type'><span class='homogen--type'>Method</span> + <span class='homogen--name'><b>_annotations</b></span> + </dt> + <dd><p><code><code class='datatype'>array</code> <b><span class='method'>_annotations</span>(</b><code class='datatype'>object</code>|<code class='datatype'>void</code> <code class='argument'>context</code>, <code class='datatype'>int</code>|<code class='datatype'>void</code> <code class='argument'>access</code>, <code class='datatype'>bool</code>|<code class='datatype'>void</code> <code class='argument'>recursive</code><b>)</b></code></p></dd> +  + <dt class='head--doc'>Description</dt> + <dd class='body--doc'><p>Called by <code class='reference unresolved'>annotations()</code></p> + </dd> + <dt class='head--doc'><span id='p-context'></span>Parameter <code class='parameter'>context</code></dt> + <dd></dd><dd class='body--doc'><p>Inherit in the current object to return the annotations for. +  If <code class='expr'>UNDEFINED</code> or left out, <code class='expr'>this_program::this</code> +  should be used (ie start at the current context and ignore +  any overloaded symbols).</p> + </dd> + <dt class='head--doc'><span id='p-access'></span>Parameter <code class='parameter'>access</code></dt> + <dd></dd><dd class='body--doc'><p>Access permission override. One of the following:</p> + <table class='box'><tr><td><code><code class='key'>0</code></code></td><td rowspan='2'><p>See only public symbols.</p> + </td></tr> + <tr><td><code><code class='key'>UNDEFINED</code></code></td></tr> + <tr><td><code><code class='key'>1</code></code></td><td><p>See protected symbols as well.</p> + </td></tr> + </table> + </dd> + <dt class='head--doc'><span id='p-recursive'></span>Parameter <code class='parameter'>recursive</code></dt> + <dd></dd><dd class='body--doc'><p>Include nested annotations from the inherits.</p> + <p> Builtin function to list the annotations (if any) of the identifiers +  of an object. This is useful when <code class='reference unresolved'>lfun::_annotations</code> has been overloaded.</p> + </dd> + <dt class='head--doc'>See also</dt> + <dd class='body--doc'><p><code class='reference unresolved'>annotations()</code>, <code class='reference unresolved'>lfun::_annotations()</code></p> + </dd></dl> +  +  </article> +  </div> +  </div> +  </div> +  <footer> +  <div id="build-date">Extracted from <strong data-id="version"></strong> as of <strong data-id="date" data-timestamp=""></strong>.</div> +  </footer> +  <script>PikeDoc.current = {"link":"ex/_3A_3A/_annotations.html","name":"_annotations"};</script> + <script src='../../ex/_3A_3A/index.js'></script> + <script src='../../ex/_3A_3A/load_index.js'></script> +  <script> +  // Tell PikeDoc that next actions are from loaded scripts +  PikeDoc.isInline = false; +  </script> +  </body> + </html>   Newline at end of file added.