computer_glamour
/
privatebin-mirror
oglindă de https://github.com/PrivateBin/PrivateBin


			
				
					
						
						
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690
							<!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={+IO.encoding+}" />
		<meta name="generator" content="JsDoc Toolkit" />
		{! Link.base = "../"; /* all generated links will be relative to this */ !}
		<title>JsDoc Reference - {+data.alias+}</title>
		<link href="../css/default.css" type="text/css" rel="stylesheet" media="all" />
	</head>

	<body>
		{+include("static/header.html")+}

		<div class="index">
			<div class="menu">
				<!-- begin publish.classesIndex -->
				{+publish.classesIndex+}
				<!-- end publish.classesIndex -->
			</div>
			
			<div class="fineprint" style="clear:both">
				<if test="JSDOC.opt.D.copyright">&copy;{+JSDOC.opt.D.copyright+}<br /></if>
				Generated by <a href="http://code.google.com/p/jsdoc-toolkit/" target="_blank">JsDoc Toolkit</a> {+JSDOC.VERSION+} on {+new Date()+}<br />
				HTML template: <a href="http://www.thebrightlines.com/2010/05/06/new-template-for-jsdoctoolkit-codeview/" target="_blank">Codeview</a>
			</div>
		</div>
		
		<div class="content">
			<div class="innerContent">
				<h1 class="classTitle">
					{!
						var classType = "";
						
						if (data.isBuiltin()) {
							classType += "Built-In ";
						}
						
						if (data.isNamespace) {
							if (data.is('FUNCTION')) {
								classType += "Function ";
							}
							classType += "Namespace ";
						} else {
							classType += "Class ";
						}
					!}
					{+classType+}<span>{+data.alias+}</span>
				</h1>

				<p class="description summary">
					<if test="data.version">
						<strong>Version {+ data.version +}.</strong><br />
					</if>
					
					<if test="data.augments.length"><br />Extends
						{+
							data.augments
							.sort()
							.map(
								function($) { return new Link().toSymbol($); }
							)
							.join(", ")
						+}.<br />
					</if>
				
					{+resolveLinks(data.classDesc)+}
					
					<if test="!data.isBuiltin()">{# isn't defined in any file #}
						<br /><em>Defined in: </em> {+new Link().toSrc(data.srcFile)+}.
					</if>
				</p>

				<if test="!data.isBuiltin() && (data.isNamespace || data.is('CONSTRUCTOR'))">
					<div class="props">
						<table class="summaryTable" cellspacing="0" summary="A summary of the constructor documented in the class {+data.alias+}.">
							<caption>{+classType+}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">{!
										if (data.isPrivate) output += "&lt;private&gt; ";
										if (data.isInner) output += "&lt;inner&gt; ";
									!}&nbsp;</td>
									<td class="nameDescription" {!if (data.comment.getTag("hilited").length){output += 'style="color: red"'}!}>
										<div class="fixedFont">
											<b>{+ new Link().toSymbol(data.alias).inner('constructor')+}</b><if test="classType != 'Namespace '">{+ makeSignature(data.params) +}</if>
										</div>
										<div class="description">{+resolveLinks(summarize(data.desc))+}</div>
									</td>
								</tr>
							</tbody>
						</table>
					</div>
				</if>

				<if test="data.properties.length">
					{! var ownProperties = data.properties.filter(function($){return $.memberOf == data.alias && !$.isNamespace}).sort(makeSortby("name")); !}
					<if test="ownProperties.length">
						<div class="props">
							<table class="summaryTable" cellspacing="0" summary="A summary of the fields documented in the class {+data.alias+}.">
								<caption>Field Summary</caption>
								
								<thead>
									<tr>
										<th scope="col">Field Attributes</th>
										<th scope="col">Field Name and Description</th>
									</tr>
								</thead>
								
								<tbody>
									<for each="member" in="ownProperties">
										<tr>
											<td class="attributes">{!
												if (member.isPrivate) output += "&lt;private&gt; ";
												if (member.isInner) output += "&lt;inner&gt; ";
												if (member.isStatic) output += "&lt;static&gt; ";
												if (member.isConstant) output += "&lt;constant&gt; ";
											!}&nbsp;</td>
											<td class="nameDescription">
												<div class="fixedFont">
												<if test="member.isStatic && member.memberOf != '_global_'">{+member.memberOf+}.</if><b>{+new Link().toSymbol(member.alias).withText(member.name)+}</b>
												</div>
												<div class="description">{+resolveLinks(summarize(member.desc))+}</div>
											</td>
										</tr>
									</for>
								</tbody>
							</table>
						</div>
					</if>
					
					<if test="data.inheritsFrom.length">
						<dl class="inheritsList">
						{!
							var borrowedMembers = data.properties.filter(function($) {return $.memberOf != data.alias});
							
							var contributers = [];
							borrowedMembers.map(function($) {if (contributers.indexOf($.memberOf) < 0) contributers.push($.memberOf)});
							for (var i = 0, l = contributers.length; i < l; i++) {
								output +=
									"<dt>Fields borrowed from class "+new Link().toSymbol(contributers[i])+": </dt>"
									+
									"<dd>" +
									borrowedMembers
									.filter(
										function($) { return $.memberOf == contributers[i] }
									)
									.sort(makeSortby("name"))
									.map(
										function($) { return new Link().toSymbol($.alias).withText($.name) }
									)
									.join(", ")
									+
									"</dd>";
							}
						!}
						</dl>
					</if>
				</if>

	<!--
	#### METHODS SUMMARY
	-->
				<if test="data.methods.length">
					{! var ownMethods = data.methods.filter(function($){return $.memberOf == data.alias  && !$.isNamespace}).sort(makeSortby("name")); !}
					<if test="ownMethods.length">
						<div class="props">
							<table class="summaryTable" cellspacing="0" summary="A summary of the methods documented in the class {+data.alias+}.">
								<caption>Method Summary</caption>
								
								<thead>
									<tr>
										<th scope="col">Method Attributes</th>
										<th scope="col">Method Name and Description</th>
									</tr>
								</thead>
								
								<tbody>
									<for each="member" in="ownMethods">
										<tr>
											<td class="attributes">{!
												if (member.isPrivate) output += "&lt;private&gt; ";
												if (member.isInner) output += "&lt;inner&gt; ";
												if (member.isStatic) output += "&lt;static&gt; ";
											!}&nbsp;</td>
											<td class="nameDescription">
												<div class="fixedFont"><if test="member.isStatic && member.memberOf != '_global_'">{+member.memberOf+}.</if><b>{+new Link().toSymbol(member.alias).withText(member.name.replace(/\^\d+$/, ''))+}</b>{+makeSignature(member.params)+}
												</div>
												<div class="description">{+resolveLinks(summarize(member.desc))+}</div>
											</td>
										</tr>
									</for>
								</tbody>
							</table>
						</div>
					</if>
					
					<if test="data.inheritsFrom.length">
						<dl class="inheritsList">
						{!
							var borrowedMembers = data.methods.filter(function($) {return $.memberOf != data.alias});
							var contributers = [];
							borrowedMembers.map(function($) {if (contributers.indexOf($.memberOf) < 0) contributers.push($.memberOf)});
							for (var i = 0, l = contributers.length; i < l; i++) {
								output +=
									"<dt>Methods borrowed from class "+new Link().toSymbol(contributers[i])+": </dt>"
									+
									"<dd>" +
									borrowedMembers
									.filter(
										function($) { return $.memberOf == contributers[i] }
									)
									.sort(makeSortby("name"))
									.map(
										function($) { return new Link().toSymbol($.alias).withText($.name) }
									)
									.join(", ")
									+
									"</dd>";
							}
						!}
						</dl>
					</if>
				</if>
				
	<!--
	#### EVENTS SUMMARY
	-->
				<if test="data.events.length">
					{! var ownEvents = data.events.filter(function($){return $.memberOf == data.alias  && !$.isNamespace}).sort(makeSortby("name")); !}
					<if test="ownEvents.length">
					<div class="props">
						<table class="summaryTable" cellspacing="0" summary="A summary of the events documented in the class {+data.alias+}.">
							<caption>Event Summary</caption>
							
							<thead>
								<tr>
									<th scope="col">Event Attributes</th>
									<th scope="col">Event Name and Description</th>
								</tr>
							</thead>
							
							<tbody>
								<for each="member" in="ownEvents">
									<tr>
										<td class="attributes">{!
											if (member.isPrivate) output += "&lt;private&gt; ";
											if (member.isInner) output += "&lt;inner&gt; ";
											if (member.isStatic) output += "&lt;static&gt; ";
										!}&nbsp;</td>
										<td class="nameDescription">
											<div class="fixedFont"><if test="member.isStatic && member.memberOf != '_global_'">{+member.memberOf+}.</if><b>{+new Link().toSymbol(member.alias).withText(member.name)+}</b>{+makeSignature(member.params)+}
											</div>
											<div class="description">{+resolveLinks(summarize(member.desc))+}</div>
										</td>
									</tr>
								</for>
							</tbody>
						</table>
					</div>
					</if>
					
					<if test="data.inheritsFrom.length">
						<dl class="inheritsList">
						{!
							var borrowedMembers = data.events.filter(function($) {return $.memberOf != data.alias});
							var contributers = [];
							borrowedMembers.map(function($) {if (contributers.indexOf($.memberOf) < 0) contributers.push($.memberOf)});
							for (var i = 0, l = contributers.length; i < l; i++) {
								output +=
									"<dt>Events borrowed from class "+new Link().toSymbol(contributers[i])+": </dt>"
									+
									"<dd>" +
									borrowedMembers
									.filter(
										function($) { return $.memberOf == contributers[i] }
									)
									.sort(makeSortby("name"))
									.map(
										function($) { return new Link().toSymbol($.alias).withText($.name) }
									)
									.join(", ")
									+
									"</dd>";
							}
						
						!}
						</dl>
					</if>
				</if>

	<!--
	#### CONSTRUCTOR DETAILS
	-->
				<if test="!data.isBuiltin() && (data.isNamespace || data.is('CONSTRUCTOR'))">
					<div class="details props">
						<div class="innerProps">
							<a name="constructor"></a>
							
							<div class="sectionTitle">
								{+classType+}Detail
							</div>
							
							<div class="fixedFont">{!
								if (data.isPrivate) output += "&lt;private&gt; ";
								if (data.isInner) output += "&lt;inner&gt; ";
							!}
								<b>{+ data.alias +}</b><if test="classType != 'Namespace '">{+ makeSignature(data.params) +}</if>
							</div>
							
							<div class="description">
								{+resolveLinks(data.desc)+}
								<if test="data.author"><br /><i>Author: </i>{+data.author+}.</if>
							</div>
							
							<if test="data.example.length">
								<for each="example" in="data.example">
									<pre class="code">{+example+}</pre>
								</for>
							</if>
						
							<if test="data.params.length">
								<dl class="detailList params">
									<dt class="heading">Parameters:</dt>
									<for each="item" in="data.params">
										<dt>
											{+((item.type)?""+("<span class=\"light fixedFont\">{"+(new Link().toSymbol(item.type)+"}</span> ")) : "")+} <b>{+item.name+}</b>
											<if test="item.isOptional"><i>Optional<if test="item.defaultValue">, Default: {+item.defaultValue+}</if></i></if>
										</dt>
										<dd>{+resolveLinks(item.desc)+}</dd>
									</for>
								</dl>
							</if>
							
							<if test="data.deprecated || data.since || data.exceptions.length || data.returns.length || data.requires.length || data.see.length">
								<dl class="detailList nomargin">
									<if test="data.deprecated">
										<dt>
											{+resolveLinks(data.deprecated)+}
										</dt>
									</if>
									
									<if test="data.since">
										<dt class="heading">Since:</dt>
										<dd>{+ data.since +}</dd>
									</if>
									
									<if test="data.exceptions.length">
										<dt class="heading">Throws:</dt>
										<for each="item" in="data.exceptions">
											<dt>
												{+((item.type)?"<span class=\"light fixedFont\">{"+(new Link().toSymbol(item.type))+"}</span> " : "")+} <b>{+item.name+}</b>
											</dt>
												<dd>{+resolveLinks(item.desc)+}</dd>
										</for>
									</if>
									
									<if test="data.returns.length">
										<dt class="heading">Returns:</dt>
										<for each="item" in="data.returns">
												<dd>{+((item.type)?"<span class=\"light fixedFont\">{"+(new Link().toSymbol(item.type))+"}</span> " : "")+}{+resolveLinks(item.desc)+}</dd>
										</for>
									</if>
									
									<if test="data.requires.length">
										<dt class="heading">Requires:</dt>
										<for each="item" in="data.requires">
											<dd>{+ resolveLinks(item) +}</dd>
										</for>
									</if>
									
									<if test="data.see.length">
										<dt class="heading">See:</dt>
										<for each="item" in="data.see">
											<dd>{+ new Link().toSymbol(item) +}</dd>
										</for>
									</if>
								</dl>
							</if>
						</div>
					</div>
				</if>

	<!--
	#### FIELD DETAILS
	-->
				<if test="defined(ownProperties) && ownProperties.length">
					<div class="details props">
						<div class="innerProps">

							<div class="sectionTitle">
								Field Detail
							</div>
							
							<for each="member" in="ownProperties">
								<a name="{+Link.symbolNameToLinkName(member)+}"></a>
								
								<div class="fixedFont heading">
									<span class='lighter'>
									{!
										if (member.isPrivate) output += "&lt;private&gt; ";
										if (member.isInner) output += "&lt;inner&gt; ";
										if (member.isStatic) output += "&lt;static&gt; ";
										if (member.isConstant) output += "&lt;constant&gt; ";
									!}
									</span>
									
									<if test="member.type"><span class="light">{{+new Link().toSymbol(member.type)+}}</span></if>
									
									<if test="member.isStatic && member.memberOf != '_global_'"><span class="light">{+member.memberOf+}.</span></if><b>{+member.name+}</b>							
								</div>
								
								<div class="description">
									{+resolveLinks(member.desc)+}
									<if test="member.srcFile != data.srcFile">
										<br />
										<i>Defined in: </i> {+new Link().toSrc(member.srcFile)+}.
									</if>
									
									<if test="member.author"><br /><i>Author: </i>{+member.author+}.</if>
								</div>
								
								<if test="member.example.length">
									<for each="example" in="member.example">
										<pre class="code">{+example+}</pre>
									</for>
								</if>

								<if test="member.deprecated || member.since || member.see.length || member.defaultValue">
									<dl class="detailList nomargin">
									
										<if test="member.deprecated">
											<dt class="heading">Deprecated:</dt>
											<dt>
												{+ resolveLinks(member.deprecated) +}
											</dt>
										</if>
										<if test="member.since">
											<dt class="heading">Since:</dt>
											<dd>{+ member.since +}</dd>
										</if>
										<if test="member.see.length">
											<dt class="heading">See:</dt>
											<for each="item" in="member.see">
												<dd>{+ new Link().toSymbol(item) +}</dd>
											</for>
										</if>
										<if test="member.defaultValue">
											<dt class="heading">Default Value:</dt>
											<dd>
												{+resolveLinks(member.defaultValue)+}
											</dd>
										</if>
									</dl>
								</if>
								
								<if test="!$member_last"><div class="hr"></div></if>
							</for>
						</div>
					</div>
				</if>

	<!--
	#### METHOD DETAILS
	-->		
				<if test="defined(ownMethods) && ownMethods.length">
					<div class="details props">
						<div class="innerProps">
							<div class="sectionTitle">
								Method Detail
							</div>
							
							<for each="member" in="ownMethods">
								<a name="{+Link.symbolNameToLinkName(member)+}"></a>
								
								<div class="fixedFont heading">
									<span class='lighter'>
									{!
										if (member.isPrivate) output += "&lt;private&gt; ";
										if (member.isInner) output += "&lt;inner&gt; ";
										if (member.isStatic) output += "&lt;static&gt; ";
									!}
									</span>
									
									<if test="member.type"><span class="light">{{+new Link().toSymbol(member.type)+}}</span></if>
									
									<if test="member.isStatic && member.memberOf != '_global_'"><span class="light">{+member.memberOf+}.</span></if><b>{+member.name.replace(/\^\d+$/, '')+}</b>{+makeSignature(member.params)+}
								</div>
								
								<div class="description">
									{+resolveLinks(member.desc)+}
									
									<if test="member.srcFile != data.srcFile">
										<br />
										<i>Defined in: </i> {+new Link().toSrc(member.srcFile)+}.
									</if>
									
									<if test="member.author"><br /><i>Author: </i>{+member.author+}.</if>
								</div>
								
								<if test="member.example.length">
									<for each="example" in="member.example">
										<pre class="code">{+example+}</pre>
									</for>
								</if>
								
								<if test="member.params.length">
									<dl class="detailList params">
										<dt class="heading">Parameters:</dt>
										<for each="item" in="member.params">
											<dt>
												{+((item.type)?"<span class=\"light fixedFont\">{"+(new Link().toSymbol(item.type))+"}</span> " : "")+}<b>{+item.name+}</b>
												<if test="item.isOptional"><i>Optional<if test="item.defaultValue">, Default: {+item.defaultValue+}</if></i></if>
											</dt>
											<dd>{+resolveLinks(item.desc)+}</dd>
										</for>
									</dl>
								</if>
								
								<if test="member.deprecated || member.since || member.exceptions.length || member.returns.length || member.requires.length || member.see.length">
									<dl class="detailList nomargin">
									
										<if test="member.deprecated">
											<dt class="heading">Deprecated:</dt>
											<dt>
												{+ resolveLinks(member.deprecated) +}
											</dt>
										</if>
										
										<if test="member.since">
											<dt class="heading">Since:</dt>
											<dd>{+ member.since +}</dd>
										</if>
										
										<if test="member.exceptions.length">
											<dt class="heading">Throws:</dt>
											<for each="item" in="member.exceptions">
												<dt>
													{+((item.type)?"<span class=\"light fixedFont\">{"+(new Link().toSymbol(item.type))+"}</span> " : "")+} <b>{+item.name+}</b>
												</dt>
												<dd>{+resolveLinks(item.desc)+}</dd>
											</for>
										</if>
										
										<if test="member.returns.length">
											<dt class="heading">Returns:</dt>
											<for each="item" in="member.returns">
												<dd>{+((item.type)?"<span class=\"light fixedFont\">{"+(new Link().toSymbol(item.type))+"}</span> " : "")+}{+resolveLinks(item.desc)+}</dd>
											</for>
										</if>
										
										<if test="member.requires.length">
											<dt class="heading">Requires:</dt>
											<for each="item" in="member.requires">
												<dd>{+ resolveLinks(item) +}</dd>
											</for>
										</if>
										
										<if test="member.see.length">
											<dt class="heading">See:</dt>
											<for each="item" in="member.see">
												<dd>{+ new Link().toSymbol(item) +}</dd>
											</for>
										</if>
									
									</dl>
								</if>

								<if test="!$member_last"><div class="hr"></div></if>
							</for>
						</div>
					</div>
				</if>
				
	<!--
	#### EVENT DETAILS
	-->		
				<if test="defined(ownEvents) && ownEvents.length">
					<div class="details props">
						<div class="innerProps">
							<div class="sectionTitle">
								Event Detail
							</div>
							
							<for each="member" in="ownEvents">
								<a name="event:{+Link.symbolNameToLinkName(member)+}"> </a>
								
								<div class="fixedFont heading">
									<span class='lighter'>
									{!
										if (member.isPrivate) output += "&lt;private&gt; ";
										if (member.isInner) output += "&lt;inner&gt; ";
										if (member.isStatic) output += "&lt;static&gt; ";
									!}
									</span>
									
									<if test="member.type"><span class="light">{{+new Link().toSymbol(member.type)+}}</span></if>
									
									<if test="member.isStatic && member.memberOf != '_global_'"><span class="light">{+member.memberOf+}.</span></if><b>{+member.name+}</b>{+makeSignature(member.params)+}
								</div>
								
								<div class="description">
									{+resolveLinks(member.desc)+}
									
									<if test="member.srcFile != data.srcFile">
										<br />
										<i>Defined in: </i> {+new Link().toSrc(member.srcFile)+}.
									</if>
									
									<if test="member.author"><br /><i>Author: </i>{+member.author+}.</if>
								</div>
								
								<if test="member.example.length">
									<for each="example" in="member.example">
										<pre class="code">{+example+}</pre>
									</for>
								</if>
								
								<if test="member.params.length">
									<dl class="detailList params">
										<dt class="heading">Parameters:</dt>
										<for each="item" in="member.params">
											<dt>
												{+((item.type)?"<span class=\"light fixedFont\">{"+(new Link().toSymbol(item.type))+"}</span> " : "")+}<b>{+item.name+}</b>
												<if test="item.isOptional"><i>Optional<if test="item.defaultValue">, Default: {+item.defaultValue+}</if></i></if>
											</dt>
											<dd>{+ resolveLinks(item.desc) +}</dd>
										</for>
									</dl>
								</if>
								
								<if test="member.deprecated || member.since || member.exceptions.length || member.returns.length || member.see.length">
									<dl class="detailList nomargin">
										<if test="member.deprecated">
											<dt class="heading">Deprecated:</dt>
											<dt>{+ resolveLinks(member.deprecated) +}</dt>
										</if>
										
										<if test="member.since">
											<dt class="heading">Since:</dt>
											<dd>{+ member.since +}</dd>
										</if>
										
										<if test="member.exceptions.length">
											<dt class="heading">Throws:</dt>
											<for each="item" in="member.exceptions">
												<dt>
													{+((item.type)?"<span class=\"light fixedFont\">{"+(new Link().toSymbol(item.type))+"}</span> " : "")+} <b>{+item.name+}</b>
												</dt>
												<dd>{+ resolveLinks(item.desc) +}</dd>
											</for>
										</if>
										
										<if test="member.returns.length">
											<dt class="heading">Returns:</dt>
											<for each="item" in="member.returns">
												<dd>{+((item.type)?"<span class=\"light fixedFont\">{"+(new Link().toSymbol(item.type))+"}</span> " : "")+}{+resolveLinks(item.desc)+}</dd>
											</for>
										</if>
										
										<if test="member.requires.length">
											<dt class="heading">Requires:</dt>
											<for each="item" in="member.requires">
												<dd>{+ resolveLinks(item) +}</dd>
											</for>
										</if>
										
										<if test="member.see.length">
											<dt class="heading">See:</dt>
											<for each="item" in="member.see">
												<dd>{+ new Link().toSymbol(item) +}</dd>
											</for>
										</if>
									</dl>
								</if>
								
								<if test="!$member_last"><div class="hr"></div></if>
							</for>
						</div>
					</div>
				</if>
			</div>
		</div>
	</body>
</html>