RubyGems - xultestrunner - Versions diffs - 0.2.8 - Mend

xultestrunner 0.2.8

Files changed (153) hide show

data/xulapp/chrome/content/vendor/xpcomcore/doc/symbols/Kernel.html ADDED Viewed

@@ -0,0 +1,1030 @@
+<!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" xml:lang="en" lang="en">
+	<head>
+		<meta http-equiv="content-type" content="text/html; charset=utf-8" />
+		<meta name="generator" content="JsDoc Toolkit" />
+		<title>JsDoc Reference - Kernel</title>
+		<style type="text/css">
+			/* default.css */
+body
+{
+	font: 12px "Lucida Grande", Tahoma, Arial, Helvetica, sans-serif;
+	width: 800px;
+}
+.header
+{
+	clear: both;
+	background-color: #ccc;
+	padding: 8px;
+}
+h1
+{
+	font-size: 150%;
+	font-weight: bold;
+	padding: 0;
+	margin: 1em 0 0 .3em;
+}
+hr
+{
+	border: none 0;
+	border-top: 1px solid #7F8FB1;
+	height: 1px;
+}
+pre.code
+{
+	display: block;
+	padding: 8px;
+	border: 1px dashed #ccc;
+}
+#index
+{
+	margin-top: 24px;
+	float: left;
+	width: 160px;
+	position: absolute;
+	left: 8px;
+	background-color: #F3F3F3;
+	padding: 8px;
+}
+#content
+{
+	margin-left: 190px;
+	width: 600px;
+}
+.classList
+{
+	list-style-type: none;
+	padding: 0;
+	margin: 0 0 0 8px;
+	font-family: arial, sans-serif;
+	font-size: 1em;
+	overflow: auto;
+}
+.classList li
+{
+	padding: 0;
+	margin: 0 0 8px 0;
+}
+.summaryTable { width: 100%; }
+h1.classTitle
+{
+	font-size:170%;
+	line-height:130%;
+}
+h2 { font-size: 110%; }
+caption, div.sectionTitle
+{
+	background-color: #7F8FB1;
+	color: #fff;
+	font-size:130%;
+	text-align: left;
+	padding: 2px 6px 2px 6px;
+	border: 1px #7F8FB1 solid;
+}
+div.sectionTitle { margin-bottom: 8px; }
+.summaryTable thead { display: none; }
+.summaryTable td
+{
+	vertical-align: top;
+	padding: 4px;
+	border-bottom: 1px #7F8FB1 solid;
+	border-right: 1px #7F8FB1 solid;
+}
+/*col#summaryAttributes {}*/
+.summaryTable td.attributes
+{
+	border-left: 1px #7F8FB1 solid;
+	width: 140px;
+	text-align: right;
+}
+td.attributes, .fixedFont
+{
+	line-height: 15px;
+	color: #002EBE;
+	font-family: "Courier New",Courier,monospace;
+	font-size: 13px;
+}
+.summaryTable td.nameDescription
+{
+	text-align: left;
+	font-size: 13px;
+	line-height: 15px;
+}
+.summaryTable td.nameDescription, .description
+{
+	line-height: 15px;
+	padding: 4px;
+	padding-left: 4px;
+}
+.summaryTable { margin-bottom: 8px; }
+ul.inheritsList
+{
+	list-style: square;
+	margin-left: 20px;
+	padding-left: 0;
+}
+.detailList {
+	margin-left: 20px;
+	line-height: 15px;
+}
+.detailList dt { margin-left: 20px; }
+.detailList .heading
+{
+	font-weight: bold;
+	padding-bottom: 6px;
+	margin-left: 0;
+}
+.light, td.attributes, .light a:link, .light a:visited
+{
+	color: #777;
+	font-style: italic;
+}
+.fineprint
+{
+	text-align: right;
+	font-size: 10px;
+}
+		</style>
+	</head>
+	<body>
+<!-- ============================== header ================================= -->
+		<!-- begin static/header.html -->
+		<div id="header">
+</div>
+		<!-- end static/header.html -->
+<!-- ============================== classes index ============================ -->
+		<div id="index">
+			<!-- begin publish.classesIndex -->
+			<div align="center"><a href="../index.html">Class Index</a>
+| <a href="../files.html">File Index</a></div>
+<hr />
+<h2>Classes</h2>
+<ul class="classList">
+	<li><i><a href="../symbols/_global_.html">_global_</a></i></li>
+	<li><a href="../symbols/Error.html">Error</a></li>
+	<li><a href="../symbols/Kernel.html">Kernel</a></li>
+	<li><a href="../symbols/LoadError.html">LoadError</a></li>
+	<li><a href="../symbols/SelfConceptError.html">SelfConceptError</a></li>
+</ul>
+<hr />
+			<!-- end publish.classesIndex -->
+		</div>
+		<div id="content">
+<!-- ============================== class title ============================ -->
+			<h1 class="classTitle">
+				Class Kernel
+			</h1>
+<!-- ============================== class summary ========================== -->
+			<p class="description">
+				Our central 'class' containing a lot of properties and methods we need to
+build the rest of XPCOMCore on top of.
+					<br /><i>Defined in: </i> <a href="../symbols/src/lib_kernel.js.html">kernel.js</a>.
+			</p>
+<!-- ============================== constructor summary ==================== -->
+			<table class="summaryTable" cellspacing="0" summary="A summary of the constructor documented in the class Kernel.">
+				<caption>Class Summary</caption>
+				<thead>
+					<tr>
+						<th scope="col">Constructor Attributes</th>
+						<th scope="col">Constructor Name and Description</th>
+					</tr>
+				</thead>
+				<tbody>
+					<tr>
+						<td class="attributes">&nbsp;</td>
+						<td class="nameDescription" >
+							<div class="fixedFont">
+								<b><a href="../symbols/Kernel.html#constructor">Kernel</a></b>(mixinScope)
+							</div>
+							<div class="description">A pseudo-constructor to make JSDoc happy and actually document things in <a href="../symbols/Kernel.html">Kernel</a>.</div>
+						</td>
+					</tr>
+				</tbody>
+			</table>
+<!-- ============================== properties summary ===================== -->
+				<table class="summaryTable" cellspacing="0" summary="A summary of the fields documented in the class Kernel.">
+					<caption>Field Summary</caption>
+					<thead>
+						<tr>
+							<th scope="col">Field Attributes</th>
+							<th scope="col">Field Name and Description</th>
+						</tr>
+					</thead>
+					<tbody>
+						<tr>
+							<td class="attributes">&nbsp;</td>
+							<td class="nameDescription">
+								<div class="fixedFont">
+								<b><a href="../symbols/Kernel.html#$Cc">$Cc</a></b>
+								</div>
+								<div class="description">A shortcut constant to Components.classes.</div>
+							</td>
+						</tr>
+						<tr>
+							<td class="attributes">&nbsp;</td>
+							<td class="nameDescription">
+								<div class="fixedFont">
+								<b><a href="../symbols/Kernel.html#$Ci">$Ci</a></b>
+								</div>
+								<div class="description">A shortcut constant to Components.interfaces.</div>
+							</td>
+						</tr>
+						<tr>
+							<td class="attributes">&nbsp;</td>
+							<td class="nameDescription">
+								<div class="fixedFont">
+								<b><a href="../symbols/Kernel.html#$Cr">$Cr</a></b>
+								</div>
+								<div class="description">A shortcut constant to Components.results.</div>
+							</td>
+						</tr>
+						<tr>
+							<td class="attributes">&nbsp;</td>
+							<td class="nameDescription">
+								<div class="fixedFont">
+								<b><a href="../symbols/Kernel.html#$Cu">$Cu</a></b>
+								</div>
+								<div class="description">A shortcut constant to Components.utils.</div>
+							</td>
+						</tr>
+						<tr>
+							<td class="attributes">&nbsp;</td>
+							<td class="nameDescription">
+								<div class="fixedFont">
+								<b><a href="../symbols/Kernel.html#$LOAD_PATH">$LOAD_PATH</a></b>
+								</div>
+								<div class="description">Taking inspiration from Ruby, this defines the set of paths to check when
+trying to load a file via either <a href="../symbols/Kernel.html#load">Kernel#load</a> or <a href="../symbols/Kernel.html#require">Kernel#require</a>.</div>
+							</td>
+						</tr>
+						<tr>
+							<td class="attributes">&nbsp;</td>
+							<td class="nameDescription">
+								<div class="fixedFont">
+								<b><a href="../symbols/Kernel.html#$LOADED_FEATURES">$LOADED_FEATURES</a></b>
+								</div>
+								<div class="description">Taking inspiration from Ruby, this defines the currently loaded files that
+have been loaded through <a href="../symbols/Kernel.html#require">Kernel#require</a>.</div>
+							</td>
+						</tr>
+					</tbody>
+				</table>
+<!-- ============================== methods summary ======================== -->
+				<table class="summaryTable" cellspacing="0" summary="A summary of the methods documented in the class Kernel.">
+					<caption>Method Summary</caption>
+					<thead>
+						<tr>
+							<th scope="col">Method Attributes</th>
+							<th scope="col">Method Name and Description</th>
+						</tr>
+					</thead>
+					<tbody>
+						<tr>
+							<td class="attributes">&nbsp;</td>
+							<td class="nameDescription">
+								<div class="fixedFont"><b><a href="../symbols/Kernel.html#$CURRENT_DIRECTORY">$CURRENT_DIRECTORY</a></b>(stackTraversalDepth)
+								</div>
+								<div class="description">This method tries to determine the filesystem path to parent directory of the caller
+code of this method NOTE - see the note on $CURRENT_FILE, as the same applies here.</div>
+							</td>
+						</tr>
+						<tr>
+							<td class="attributes">&nbsp;</td>
+							<td class="nameDescription">
+								<div class="fixedFont"><b><a href="../symbols/Kernel.html#$CURRENT_FILE">$CURRENT_FILE</a></b>(stackTraversalDepth)
+								</div>
+								<div class="description">Taking inspiration from Ruby, this method tries to determine the filesystem path to
+the caller code of this method.</div>
+							</td>
+						</tr>
+						<tr>
+							<td class="attributes">&nbsp;</td>
+							<td class="nameDescription">
+								<div class="fixedFont"><b><a href="../symbols/Kernel.html#load">load</a></b>(featurePath)
+								</div>
+								<div class="description">Searches {@link Kernel#$LOAD_PATH $LOAD_PATH} for files to load into the current global scope.</div>
+							</td>
+						</tr>
+						<tr>
+							<td class="attributes">&lt;inner&gt; &nbsp;</td>
+							<td class="nameDescription">
+								<div class="fixedFont"><b><a href="../symbols/Kernel.html#-makeCallingGetter">makeCallingGetter</a></b>(attr, argsArray)
+								</div>
+								<div class="description"></div>
+							</td>
+						</tr>
+						<tr>
+							<td class="attributes">&lt;inner&gt; &nbsp;</td>
+							<td class="nameDescription">
+								<div class="fixedFont"><b><a href="../symbols/Kernel.html#-makeGetter">makeGetter</a></b>(attr)
+								</div>
+								<div class="description"></div>
+							</td>
+						</tr>
+						<tr>
+							<td class="attributes">&nbsp;</td>
+							<td class="nameDescription">
+								<div class="fixedFont"><b><a href="../symbols/Kernel.html#print">print</a></b>(str)
+								</div>
+								<div class="description">Prints a string to standard out, without a trailing newline.</div>
+							</td>
+						</tr>
+						<tr>
+							<td class="attributes">&nbsp;</td>
+							<td class="nameDescription">
+								<div class="fixedFont"><b><a href="../symbols/Kernel.html#puts">puts</a></b>(str)
+								</div>
+								<div class="description">Prints a string to standard out, with a trailing newline.</div>
+							</td>
+						</tr>
+						<tr>
+							<td class="attributes">&nbsp;</td>
+							<td class="nameDescription">
+								<div class="fixedFont"><b><a href="../symbols/Kernel.html#require">require</a></b>(featurePath)
+								</div>
+								<div class="description">Searches {@link Kernel#$LOAD_PATH $LOAD_PATH} for features to load into the current global scope.</div>
+							</td>
+						</tr>
+						<tr>
+							<td class="attributes">&lt;inner&gt; &nbsp;</td>
+							<td class="nameDescription">
+								<div class="fixedFont"><b><a href="../symbols/Kernel.html#-standardLibraryLoader">standardLibraryLoader</a></b>()
+								</div>
+								<div class="description"></div>
+							</td>
+						</tr>
+					</tbody>
+				</table>
+<!-- ============================== events summary ======================== -->
+<!-- ============================== constructor details ==================== -->
+			<div class="details"><a name="constructor"> </a>
+				<div class="sectionTitle">
+					Class Detail
+				</div>
+				<div class="fixedFont">
+						<b>Kernel</b>(mixinScope)
+				</div>
+				<div class="description">
+					A pseudo-constructor to make JSDoc happy and actually document things in <a href="../symbols/Kernel.html">Kernel</a>.
+If this method is called with an argument, all properties from <a href="../symbols/Kernel.html">Kernel</a> are taken
+and defined as the return value of getter methods set on the given object.
+				</div>
+						<dl class="detailList">
+						<dt class="heading">Parameters:</dt>
+							<dt>
+								<span class="light fixedFont">{Object}</span>  <b>mixinScope</b>
+							</dt>
+								<dd>Optional argument, any object to mix <a href="../symbols/Kernel.html">Kernel</a>'s properties
+into.</dd>
+						</dl>
+						<dl class="detailList">
+						<dt class="heading">Returns:</dt>
+								<dd>The prototype object of the Kernel function.</dd>
+						</dl>
+			</div>
+<!-- ============================== field details ========================== -->
+				<div class="sectionTitle">
+					Field Detail
+				</div>
+					<a name="$Cc"> </a>
+					<div class="fixedFont">
+					<b>$Cc</b>
+					</div>
+					<div class="description">
+						A shortcut constant to Components.classes.
+					</div>
+					<hr />
+					<a name="$Ci"> </a>
+					<div class="fixedFont">
+					<b>$Ci</b>
+					</div>
+					<div class="description">
+						A shortcut constant to Components.interfaces.
+					</div>
+					<hr />
+					<a name="$Cr"> </a>
+					<div class="fixedFont">
+					<b>$Cr</b>
+					</div>
+					<div class="description">
+						A shortcut constant to Components.results.
+					</div>
+					<hr />
+					<a name="$Cu"> </a>
+					<div class="fixedFont">
+					<b>$Cu</b>
+					</div>
+					<div class="description">
+						A shortcut constant to Components.utils.
+					</div>
+					<hr />
+					<a name="$LOAD_PATH"> </a>
+					<div class="fixedFont">
+					<span class="light">{Array}</span>
+					<b>$LOAD_PATH</b>
+					</div>
+					<div class="description">
+						Taking inspiration from Ruby, this defines the set of paths to check when
+trying to load a file via either <a href="../symbols/Kernel.html#load">Kernel#load</a> or <a href="../symbols/Kernel.html#require">Kernel#require</a>.
+					</div>
+					<hr />
+					<a name="$LOADED_FEATURES"> </a>
+					<div class="fixedFont">
+					<span class="light">{Array}</span>
+					<b>$LOADED_FEATURES</b>
+					</div>
+					<div class="description">
+						Taking inspiration from Ruby, this defines the currently loaded files that
+have been loaded through <a href="../symbols/Kernel.html#require">Kernel#require</a>.
+					</div>
+<!-- ============================== method details ========================= -->
+				<div class="sectionTitle">
+					Method Detail
+				</div>
+					<a name="$CURRENT_DIRECTORY"> </a>
+					<div class="fixedFont">
+					<span class="light">{String}</span>
+					<b>$CURRENT_DIRECTORY</b>(stackTraversalDepth)
+					</div>
+					<div class="description">
+						This method tries to determine the filesystem path to parent directory of the caller
+code of this method NOTE - see the note on $CURRENT_FILE, as the same applies here.
+					</div>
+							<dl class="detailList">
+							<dt class="heading">Parameters:</dt>
+								<dt>
+									<span class="light fixedFont">{int}</span> <b>stackTraversalDepth</b>
+								</dt>
+								<dd>Optional argument, how far to look up the stack to
+figure out who called us. The default is usually safe.</dd>
+							</dl>
+							<dl class="detailList">
+							<dt class="heading">Throws:</dt>
+								<dt>
+									<span class="light fixedFont">{@link SelfConceptError}</span>  <b></b>
+								</dt>
+								<dd>Thrown when we can't figure out what the filesystem
+path to the parent directory of the current file is.</dd>
+							</dl>
+					<hr />
+					<a name="$CURRENT_FILE"> </a>
+					<div class="fixedFont">
+					<span class="light">{String}</span>
+					<b>$CURRENT_FILE</b>(stackTraversalDepth)
+					</div>
+					<div class="description">
+						Taking inspiration from Ruby, this method tries to determine the filesystem path to
+the caller code of this method.
+NOTE - when <a href="../symbols/Kernel.html">Kernel</a> is mixed into an object, this function gets mixed in via
+a special case behaviour that makes it a getter that actually calls the function
+rather than returning the function object itself. This is to facilitate being able
+to call '$CURRENT_FILE' in your code rather than '$CURRENT_FILE()'. The stackTraversalDepth
+parameter is there for this reason, since we need to traverse the stack further than
+normal to find the calling scope than we normally would.
+					</div>
+							<dl class="detailList">
+							<dt class="heading">Parameters:</dt>
+								<dt>
+									<span class="light fixedFont">{int}</span> <b>stackTraversalDepth</b>
+								</dt>
+								<dd>Optional argument, how far to look up the stack to
+figure out who called us. The default is usually safe.</dd>
+							</dl>
+							<dl class="detailList">
+							<dt class="heading">Throws:</dt>
+								<dt>
+									<span class="light fixedFont">{@link SelfConceptError}</span>  <b></b>
+								</dt>
+								<dd>Thrown when we can't figure out what the filesystem
+path to the current file is.</dd>
+							</dl>
+					<hr />
+					<a name="load"> </a>
+					<div class="fixedFont">
+					<span class="light">{Boolean}</span>
+					<b>load</b>(featurePath)
+					</div>
+					<div class="description">
+						Searches {@link Kernel#$LOAD_PATH $LOAD_PATH} for files to load into the current global scope.
+Files loaded via this method will not be added to <a href="../symbols/Kernel.html#$LOADED_FEATURES">Kernel#$LOADED_FEATURES</a> and hence
+can be repeatedly loaded and executed.
+					</div>
+							<dl class="detailList">
+							<dt class="heading">Parameters:</dt>
+								<dt>
+									<span class="light fixedFont">{String}</span> <b>featurePath</b>
+								</dt>
+								<dd>Full or relative path including file extension to try and load.</dd>
+							</dl>
+							<dl class="detailList">
+							<dt class="heading">Throws:</dt>
+								<dt>
+									<span class="light fixedFont">{@link LoadError}</span>  <b></b>
+								</dt>
+								<dd>Thrown when we can't find the specified file in any directories specified
+in {@link Kernel#$LOAD_PATH $LOAD_PATH}.</dd>
+							</dl>
+					<hr />
+					<a name="-makeCallingGetter"> </a>
+					<div class="fixedFont">&lt;inner&gt;
+					<b>makeCallingGetter</b>(attr, argsArray)
+					</div>
+					<div class="description">
+					</div>
+							<dl class="detailList">
+							<dt class="heading">Parameters:</dt>
+								<dt>
+									<b>attr</b>
+								</dt>
+								<dd></dd>
+								<dt>
+									<b>argsArray</b>
+								</dt>
+								<dd></dd>
+							</dl>
+					<hr />
+					<a name="-makeGetter"> </a>
+					<div class="fixedFont">&lt;inner&gt;
+					<b>makeGetter</b>(attr)
+					</div>
+					<div class="description">
+					</div>
+							<dl class="detailList">
+							<dt class="heading">Parameters:</dt>
+								<dt>
+									<b>attr</b>
+								</dt>
+								<dd></dd>
+							</dl>
+					<hr />
+					<a name="print"> </a>
+					<div class="fixedFont">
+					<b>print</b>(str)
+					</div>
+					<div class="description">
+						Prints a string to standard out, without a trailing newline.
+					</div>
+							<dl class="detailList">
+							<dt class="heading">Parameters:</dt>
+								<dt>
+									<span class="light fixedFont">{String}</span> <b>str</b>
+								</dt>
+								<dd>String to print to standard out.</dd>
+							</dl>
+					<hr />
+					<a name="puts"> </a>
+					<div class="fixedFont">
+					<b>puts</b>(str)
+					</div>
+					<div class="description">
+						Prints a string to standard out, with a trailing newline.
+					</div>
+							<dl class="detailList">
+							<dt class="heading">Parameters:</dt>
+								<dt>
+									<span class="light fixedFont">{String}</span> <b>str</b>
+								</dt>
+								<dd>String to print to standard out.</dd>
+							</dl>
+					<hr />
+					<a name="require"> </a>
+					<div class="fixedFont">
+					<span class="light">{Boolean True if successful, false if the specified feature has already been required.}</span>
+					<b>require</b>(featurePath)
+					</div>
+					<div class="description">
+						Searches {@link Kernel#$LOAD_PATH $LOAD_PATH} for features to load into the current global scope.
+Files loaded via this method will be added to <a href="../symbols/Kernel.html#$LOADED_FEATURES">Kernel#$LOADED_FEATURES</a> and hence two
+consecutive calls to this method will not load and execute the code twice.
+					</div>
+							<dl class="detailList">
+							<dt class="heading">Parameters:</dt>
+								<dt>
+									<span class="light fixedFont">{String}</span> <b>featurePath</b>
+								</dt>
+								<dd>Full or relative path without the file extension to try and require.</dd>
+							</dl>
+							<dl class="detailList">
+							<dt class="heading">Throws:</dt>
+								<dt>
+									<span class="light fixedFont">{@link LoadError}</span>  <b></b>
+								</dt>
+								<dd>Thrown when we can't find the specified feature in any directories specified
+in {@link Kernel#$LOAD_PATH $LOAD_PATH}.</dd>
+							</dl>
+					<hr />
+					<a name="-standardLibraryLoader"> </a>
+					<div class="fixedFont">&lt;inner&gt;
+					<b>standardLibraryLoader</b>()
+					</div>
+					<div class="description">
+					</div>
+<!-- ============================== event details ========================= -->
+			<hr />
+		</div>
+<!-- ============================== footer ================================= -->
+		<div class="fineprint" style="clear:both">
+			Documentation generated by <a href="http://code.google.com/p/jsdoc-toolkit/" target="_blank">JsDoc Toolkit</a> 2.3.0 on Sat Oct 03 2009 19:31:42 GMT-0500 (CDT)
+		</div>
+	</body>
+</html>