123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468 |
- <!DOCTYPE html>
- <html lang="en">
- <head>
- <meta charset="utf-8">
- <meta name="viewport" content="width=device-width">
- <title>GlobalClass</title>
- <!--[if lt IE 9]>
- <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
- <![endif]-->
- <link href="https://fonts.googleapis.com/css?family=PT+Mono" rel="stylesheet">
- <link type="text/css" rel="stylesheet" href="css/bootstrap.min.css">
- <link type="text/css" rel="stylesheet" href="css/prism.min.css">
- <link type="text/css" rel="stylesheet" href="css/template.min.css">
- <script type="text/javascript">
- window.TEMPLATE_OPTIONS = {"includeDate":true,"dateFormat":"Do MMM YYYY","systemName":"FooDoc","systemSummary":"A Bootstrap and Handlebars based template for JSDoc3.","systemLogo":"","systemColor":"","navMembers":[{"kind":"class","title":"Classes","summary":"All documented classes."},{"kind":"external","title":"Externals","summary":"All documented external members."},{"kind":"global","title":"Globals","summary":"All documented globals."},{"kind":"mixin","title":"Mixins","summary":"All documented mixins."},{"kind":"interface","title":"Interfaces","summary":"All documented interfaces."},{"kind":"module","title":"Modules","summary":"All documented modules."},{"kind":"namespace","title":"Namespaces","summary":"All documented namespaces."},{"kind":"tutorial","title":"Tutorials","summary":"All available tutorials."}],"footer":"","copyright":"FooDoc Copyright © 2016 The contributors to the JSDoc3 and FooDoc projects.","linenums":true,"collapseSymbols":true,"inverseNav":true,"inlineNav":false,"outputSourceFiles":true,"sourceRootPath":null,"disablePackagePath":true,"outputSourcePath":false,"showTableOfContents":true,"showAccessFilter":true,"analytics":null,"methodHeadingReturns":true,"sort":"linenum, longname, version, since","search":true,"favicon":null,"stylesheets":[],"scripts":[],"monospaceLinks":false,"cleverLinks":false};
- window.DOCLET_TOC_ENABLED = true;
- window.DOCLET_AFILTER_ENABLED = true;
- </script>
- </head>
- <body>
- <!-- start:navbar.hbs -->
- <header class="navbar navbar-default navbar-fixed-top navbar-inverse">
- <div class="container">
- <div class="navbar-header">
- <a class="navbar-brand" href="index.html">
- FooDoc
- </a>
- <!-- displayed on small devices -->
- <button class="navbar-toggle" type="button" data-toggle="collapse" data-target="#topNavigation">
- <span class="icon-bar"></span>
- <span class="icon-bar"></span>
- <span class="icon-bar"></span>
- </button>
- </div>
- <div class="navbar-collapse collapse" id="topNavigation">
- <ul class="nav navbar-nav">
- <li class="dropdown">
- <a href="global.html" class="dropdown-toggle" data-toggle="dropdown">Globals<b class="caret"></b></a>
- <ul class="dropdown-menu">
- <li><a href="global.html#SomeType">SomeType</a></li>
- </ul>
- </li>
- <li class="dropdown">
- <a href="list_class.html" class="dropdown-toggle" data-toggle="dropdown">Classes<b class="caret"></b></a>
- <ul class="dropdown-menu">
- <li><a href="CustomError.html">CustomError</a></li>
- <li><a href="GlobalClass.html">GlobalClass</a></li>
- <li><a href="MyApi.Child.html">MyApi.Child</a></li>
- <li><a href="MyApi.Class.html">MyApi.Class</a></li>
- </ul>
- </li>
- <li class="dropdown">
- <a href="list_namespace.html" class="dropdown-toggle" data-toggle="dropdown">Namespaces<b class="caret"></b></a>
- <ul class="dropdown-menu">
- <li><a href="MyApi.html">MyApi</a></li>
- <li><a href="MyApi.utils.html">MyApi.utils</a></li>
- </ul>
- </li>
- <li class="dropdown">
- <a href="list_tutorial.html" class="dropdown-toggle" data-toggle="dropdown">Tutorials<b class="caret"></b></a>
- <ul class="dropdown-menu">
- <li><a href="tutorial-brush-teeth.html">Brush Teeth</a></li>
- <li><a href="tutorial-drive-car.html">Drive Car</a></li>
- </ul>
- </li>
- </ul>
- <!-- start:lunr-search-navbar.hbs -->
- <form class="navbar-form navbar-right" role="search">
- <div class="input-group">
- <input type="text" class="form-control" placeholder="Search" id="lunr-search-input">
- <div class="input-group-btn">
- <button class="btn btn-default" id="lunr-search-submit">
- <i class="glyphicon glyphicon-search"></i>
- </button>
- </div>
- </div>
- </form>
- <!-- start:lunr-search-navbar.hbs --> </div>
- </div>
- </header>
- <!-- end:navbar.hbs --> <div class="page-header">
- <div class="container">
- <span class="kind">class</span>
- <h1><span class="name">GlobalClass</span></h1>
- <div class="summary"><p>This is the summary of the global test class, test <code>markdown</code>.</p></div> </div>
- </div>
- <div class="container content">
- <div class="row">
- <div class="col-md-9 main-content">
- <ol class="breadcrumb">
- <li><a href="index.html">Home</a></li>
- <li><a href="list_class.html">Classes</a></li>
- <li class="active">GlobalClass</li>
- </ol>
- <div class="access-filter">
- <label class="checkbox-inline">
- <input class="toggle-public" type="checkbox" value="" checked>
- Public
- </label>
- <label class="checkbox-inline">
- <input class="toggle-private" type="checkbox" value="" checked>
- Private
- </label>
- </div>
- <section>
- <dl class="symbol primary">
- <dt class="symbol-title class collapsible-symbol expanded">
- <h2 class="class"><span class="signature-new">new </span><span class="name">GlobalClass</span><span class="signature-params">( <span class="signature-param">arg1</span> [, <span class="signature-param">...arg2</span> ] )</span><span class="signature-type"></span></h2>
- <div class="summary"><p>This is the summary of the global test class, test <code>markdown</code>.</p></div></dt>
- <dd class="symbol-details class collapsible-symbol expanded" style="max-height: 9999px;">
- <div class="symbol-details-inner">
- <div class="callout callout-primary"><h5>Description</h5> <div class="description"><p>This is the description for the class this is meant to be a more in depth explanation of what this class does and it's general use case, test <code>markdown</code></p></div>
- </div> <div class="callout callout-info">
- <h5>Parameters</h5>
- <table class="params table table-striped">
- <thead>
- <tr>
- <th>Name</th>
- <th>Type</th>
- <th>Attributes</th>
- <th>Default</th>
- <th class="last">Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td><code>arg1</code></td>
- <td><span class="param-type">string</span></td>
- <td class="attributes"></td>
- <td></td>
- <td class="last">
- <p>The first test arg, test <code>markdown</code>.</p>
- </td>
- </tr>
- <tr>
- <td><code>arg2</code></td>
- <td><span class="param-type">string</span></td>
- <td class="attributes"><optional><br/><repeatable><br/></td>
- <td>false</td>
- <td class="last">
- <p>A repeatable, optional argument with a default value of false, test <code>markdown</code>.</p>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <div class="callout callout-example"><h5>Examples</h5> <div class="example-caption"><p>You can provide example captions with <code>markdown</code> and specify the language to use when rendering the code, defaults to <code>javascript</code>.</p></div>
- <div class="example-code">
- <pre class="prettyprint source language-javascript"><code class="language-javascript">
var gc = new GlobalClass("arg1", "arg2");</code></pre>
- </div>
- <div class="example-code">
- <pre class="prettyprint source language-xml"><code class="language-xml">
<head>
<title>HTML Highlighting</title>
<script>
// supports embedded languages
var gc = new GlobalClass("arg1", "arg2");
</script>
</head></code></pre>
- </div>
- </div> <div class="callout callout-default"><h5>Details</h5> <form class="form-horizontal details">
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- <!-- source -->
- <div class="form-group">
- <label class="col-sm-3 control-label">Source</label>
- <div class="col-sm-9">
- <p class="form-control-static"><a href="GlobalClass.js.html">GlobalClass.js</a>, <a href="GlobalClass.js.html#line-1">line 1</a></p>
- </div>
- </div>
-
-
-
-
- </form>
- </div> </div>
- </dd>
- </dl>
- <article class="secondary">
- <h3>Members</h3>
- <dl class="symbol">
- <hr/>
- <dt class="symbol-title member public collapsible-symbol">
- <h4 id="name" class="member public"><span class="name">name</span><span class="signature-type"> :string</span></h4>
- <div class="summary"><p>The name of the class.</p></div></dt>
- <dd class="symbol-details member public collapsible-symbol">
- <div class="symbol-details-inner">
- <div class="callout callout-default"><h5>Details</h5> <form class="form-horizontal details">
-
- <!-- type -->
- <div class="form-group">
- <label class="col-sm-3 control-label">Type</label>
- <div class="col-sm-9">
- <div class="form-control-static type-names"><span class="param-type">string</span></div>
- </div>
- </div>
-
- <!-- defaultvalue -->
- <div class="form-group">
- <label class="col-sm-3 control-label">Default Value</label>
- <div class="col-sm-9">
- <p class="form-control-static">"Test Global"</p>
- </div>
- </div>
-
-
-
-
-
-
-
-
-
-
-
-
-
- <!-- source -->
- <div class="form-group">
- <label class="col-sm-3 control-label">Source</label>
- <div class="col-sm-9">
- <p class="form-control-static"><a href="GlobalClass.js.html">GlobalClass.js</a>, <a href="GlobalClass.js.html#line-19">line 19</a></p>
- </div>
- </div>
-
-
-
-
- </form>
- </div> </div>
- </dd>
- <hr/>
- <dt class="symbol-title member private collapsible-symbol">
- <h4 id="_privateMember" class="member private"><span class="signature-attribs"><private> </span><span class="name">_privateMember</span><span class="signature-type"> :string</span></h4>
- <div class="summary"><p>A private member of the class.</p></div></dt>
- <dd class="symbol-details member private collapsible-symbol">
- <div class="symbol-details-inner">
- <div class="callout callout-default"><h5>Details</h5> <form class="form-horizontal details">
-
- <!-- type -->
- <div class="form-group">
- <label class="col-sm-3 control-label">Type</label>
- <div class="col-sm-9">
- <div class="form-control-static type-names"><span class="param-type">string</span></div>
- </div>
- </div>
-
- <!-- defaultvalue -->
- <div class="form-group">
- <label class="col-sm-3 control-label">Default Value</label>
- <div class="col-sm-9">
- <p class="form-control-static">"Test Global"</p>
- </div>
- </div>
-
-
-
-
-
-
-
-
-
-
-
-
-
- <!-- source -->
- <div class="form-group">
- <label class="col-sm-3 control-label">Source</label>
- <div class="col-sm-9">
- <p class="form-control-static"><a href="GlobalClass.js.html">GlobalClass.js</a>, <a href="GlobalClass.js.html#line-27">line 27</a></p>
- </div>
- </div>
-
-
-
-
- </form>
- </div> </div>
- </dd>
- </dl>
- <h3>Methods</h3>
- <dl class="symbol">
- <hr/>
- <dt class="symbol-title function public collapsible-symbol">
- <h4 id="testMethod" class="function public"><span class="name">testMethod</span><span class="signature-params">( <span class="signature-param">value</span>, <span class="signature-param">obj</span> [, <span class="signature-param">...objN</span> ] )</span><span class="signature-type"> → {Object}</span></h4>
- <div class="summary"><p>This is a test instance method of the global test class, test <code>markdown</code></p></div></dt>
- <dd class="symbol-details function public collapsible-symbol">
- <div class="symbol-details-inner">
- <div class="callout callout-info">
- <h5>Parameters</h5>
- <table class="params table table-striped">
- <thead>
- <tr>
- <th>Name</th>
- <th>Type</th>
- <th>Attributes</th>
- <th class="last">Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td><code>value</code></td>
- <td><span class="param-type">*</span></td>
- <td class="attributes"></td>
- <td class="last">
- <p>Any value, test <code>markdown</code></p>
- </td>
- </tr>
- <tr>
- <td><code>obj</code></td>
- <td><span class="param-type">Object</span></td>
- <td class="attributes"></td>
- <td class="last">
- <p>The first object of what could be many, test <code>markdown</code></p>
- </td>
- </tr>
- <tr>
- <td><code>objN</code></td>
- <td><span class="param-type">Object</span></td>
- <td class="attributes"><optional><br/><repeatable><br/></td>
- <td class="last">
- <p>Any additional objects, test <code>markdown</code></p>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <div class="callout callout-success"><h5>Returns</h5> <form class="form-horizontal returns">
- <div class="form-group">
- <label class="col-sm-3 control-label returns-type"><span class="param-type">Object</span></label>
- <div class="col-sm-9">
- <div class="form-control-static returns-description"><p>The combination of all the objects, test <code>markdown</code>.</p></div>
- </div>
- </div>
- </form>
- </div> <div class="callout callout-default"><h5>Details</h5> <form class="form-horizontal details">
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- <!-- source -->
- <div class="form-group">
- <label class="col-sm-3 control-label">Source</label>
- <div class="col-sm-9">
- <p class="form-control-static"><a href="GlobalClass.js.html">GlobalClass.js</a>, <a href="GlobalClass.js.html#line-38">line 38</a></p>
- </div>
- </div>
-
-
-
-
- </form>
- </div> </div>
- </dd>
- <hr/>
- <dt class="symbol-title function public collapsible-symbol">
- <h4 id="testMethod" class="function public"><span class="name">testMethod</span><span class="signature-params">( <span class="signature-param">type</span> )</span><span class="signature-type"></span></h4>
- <div class="summary"><p>This is a test instance method of the global test class to check that global type definitions are documented.</p></div></dt>
- <dd class="symbol-details function public collapsible-symbol">
- <div class="symbol-details-inner">
- <div class="callout callout-info">
- <h5>Parameters</h5>
- <table class="params table table-striped">
- <thead>
- <tr>
- <th>Name</th>
- <th>Type</th>
- <th class="last">Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td><code>type</code></td>
- <td><span class="param-type"><a href="global.html#SomeType">SomeType</a></span></td>
- <td class="last">
- <p>The parameter which is of type SomeType</p>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <div class="callout callout-default"><h5>Details</h5> <form class="form-horizontal details">
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- <!-- source -->
- <div class="form-group">
- <label class="col-sm-3 control-label">Source</label>
- <div class="col-sm-9">
- <p class="form-control-static"><a href="GlobalClass.js.html">GlobalClass.js</a>, <a href="GlobalClass.js.html#line-51">line 51</a></p>
- </div>
- </div>
-
-
-
-
- </form>
- </div> </div>
- </dd>
- </dl>
- </article>
- </section>
- </div>
- <div class="col-md-3 side-content">
- <nav class="toc hidden-print hidden-sm hidden-xs"></nav>
- </div>
- </div>
- </div>
- <footer>
- <div class="copyright">FooDoc Copyright © 2016 The contributors to the JSDoc3 and FooDoc projects.</div>
- <div class="generated-by">Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on 1st May 2018 using the <a href="https://github.com/steveush/foodoc">FooDoc template</a>.</div>
- </footer>
- <script src="js/jquery.min.js"></script>
- <script src="js/bootstrap.min.js"></script>
- <script src="js/clipboard.min.js"></script>
- <script src="js/prism.min.js"></script>
- <script src="js/template.min.js"></script>
- <!-- start:lunr-search-modal.hbs -->
- <div class="modal fade" id="lunr-search-modal">
- <div class="modal-dialog">
- <div class="modal-content">
- <div class="modal-header">
- <button type="button" class="close" data-dismiss="modal" aria-label="Close"><span aria-hidden="true">×</span></button>
- <h4 class="modal-title">Search results</h4>
- </div>
- <div class="modal-body" id="lunr-search-body">
- </div>
- <div class="modal-footer" id="lunr-search-footer">
- <button type="button" class="btn btn-default" data-dismiss="modal">Close</button>
- </div>
- </div><!-- /.modal-content -->
- </div><!-- /.modal-dialog -->
- </div>
- <!-- end:lunr-search-modal.hbs --> <script src="js/lunr.min.js"></script>
-
- </body>
- </html>
|