Fix 646541 - OP_applytype is not documented (r=edwsmith)
authorLars T Hansen <lhansen@adobe.com>
Wed, 14 Sep 2011 16:23:56 -0400
changeset 6582 ecae7c4f1a85807c3d6fc2c3ddf8fb731345056b
parent 6581 b02571ac42d8b252422a4e155afe19fbbf31b4b8
child 6583 e6e1ea7edd0fc97270b32210f3f2f42fe82e3441
push id3900
push userlhansen@adobe.com
push dateWed, 14 Sep 2011 20:24:01 +0000
reviewersedwsmith
bugs646541
Fix 646541 - OP_applytype is not documented (r=edwsmith)
doc/bytecode.doxyfile
doc/bytecode/html/applytype.html
doc/bytecode/src/applytype.dox
--- a/doc/bytecode.doxyfile
+++ b/doc/bytecode.doxyfile
@@ -578,16 +578,17 @@ WARN_LOGFILE =
 
 # The INPUT tag can be used to specify the files and/or directories that contain
 # documented source files. You may enter file names like "myfile.cpp" or
 # directories like "/usr/src/myproject". Separate the files or directories
 # with spaces.
 
 INPUT = bytecode/src/add.dox \
 bytecode/src/add_i.dox \
+bytecode/src/applytype.dox \
 bytecode/src/astype.dox \
 bytecode/src/astemplate.dox \
 bytecode/src/bitand.dox \
 bytecode/src/bitnot.dox \
 bytecode/src/bitor.dox \
 bytecode/src/bitxor.dox \
 bytecode/src/call.dox \
 bytecode/src/callmethod.dox \
new file mode 100644
--- /dev/null
+++ b/doc/bytecode/html/applytype.html
@@ -0,0 +1,54 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml">
+<head>
+<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
+<title>AVM2: </title>
+<link href="tabs.css" rel="stylesheet" type="text/css"/>
+<link href="doxygen.css" rel="stylesheet" type="text/css"/>
+</head>
+<body>
+<!-- Generated by Doxygen 1.6.1 -->
+<div class="navigation" id="top">
+  <div class="tabs">
+    <ul>
+      <li><a href="main.html"><span>Main&nbsp;Page</span></a></li>
+      <li class="current"><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
+    </ul>
+  </div>
+</div>
+<div class="contents">
+<p></p>
+<h2><a class="anchor" id="applytype">
+applytype</a></h2>
+<h3><a class="anchor" id="operation">
+Operation</a></h3>
+<p>Instantiate a parameterized factory type.</p>
+<h3><a class="anchor" id="format">
+Format</a></h3>
+<div class="fragment"><pre class="fragment">applytype 
+arg_count
+</pre></div><h3><a class="anchor" id="forms">
+Forms</a></h3>
+<div class="fragment"><pre class="fragment">add = 83 (0x53)
+</pre></div> <h3><a class="anchor" id="stack">
+Stack</a></h3>
+<div class="fragment"><pre class="fragment"> ..., factory, parameter1, ..., parametern =&gt; ..., newclass
+</pre></div><h3><a class="anchor" id="description">
+Description</a></h3>
+<p>arg_count is a u30 that is the number of type parameters present on the stack.</p>
+<p>Pop the parameters and the factory off of the stack and apply the factory to the parameters, yielding an instantiation of the factory with the parameters in the form of a class object.</p>
+<p>Push newclass onto the stack.</p>
+<h3><a class="anchor" id="rt_execeptions">
+Runtime exceptions</a></h3>
+<p>A TypeError is thrown if factory is not a Factory object or if the number of parameters accepted by the factory does not correspond to the number of parameters passed.</p>
+<p>A VerifyError is thrown if the parameters are not class objects.</p>
+<h3><a class="anchor" id="notes">
+Notes</a></h3>
+<p>The only Factory type in Tamarin as of the time of writing is __AS3__.vec::Vector.</p>
+<p>The use of VerifyError is a bug. </p>
+</div>
+<hr size="1"/><address style="text-align: right;"><small>Generated on Wed Sep 14 14:10:52 2011 for AVM2 by&nbsp;
+<a href="http://www.doxygen.org/index.html">
+<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address>
+</body>
+</html>
new file mode 100644
--- /dev/null
+++ b/doc/bytecode/src/applytype.dox
@@ -0,0 +1,54 @@
+/*! \page applytype 
+
+\addindex applytype
+
+\section applytype applytype
+
+\subsection operation Operation
+
+Instantiate a parameterized factory type.
+
+\subsection format Format
+
+\code
+applytype 
+arg_count
+\endcode
+
+\subsection forms Forms
+\code
+add = 83 (0x53)
+\endcode
+\subsection stack Stack
+
+\code
+ ..., factory, parameter1, ..., parametern => ..., newclass
+\endcode
+
+\subsection description Description
+
+arg_count is a u30 that is the number of type parameters present on
+the stack.
+
+Pop the parameters and the factory off of the stack and apply the
+factory to the parameters, yielding an instantiation of the factory
+with the parameters in the form of a class object.
+
+Push newclass onto the stack.
+
+\subsection rt_execeptions Runtime exceptions
+
+A TypeError is thrown if factory is not a Factory object or if the
+number of parameters accepted by the factory does not correspond to
+the number of parameters passed.
+
+A VerifyError is thrown if the parameters are not class objects.
+
+\subsection notes Notes
+
+The only Factory type in Tamarin as of the time of writing is __AS3__.vec::Vector.
+
+The use of VerifyError is a bug; see Bugzilla 686746.
+
+*/
+