@braintree/jsdoc-template 4.0.0

package/static/styles/prettify-jsdoc.css

@@ -0,0 +1,111 @@
+/* JSDoc prettify.js theme */
+
+/* plain text */
+.pln {
+  color: #000000;
+  font-weight: normal;
+  font-style: normal;
+}
+
+/* string content */
+.str {
+  color: hsl(104, 100%, 24%);
+  font-weight: normal;
+  font-style: normal;
+}
+
+/* a keyword */
+.kwd {
+  color: #000000;
+  font-weight: bold;
+  font-style: normal;
+}
+
+/* a comment */
+.com {
+  font-weight: normal;
+  font-style: italic;
+}
+
+/* a type name */
+.typ {
+  color: #000000;
+  font-weight: normal;
+  font-style: normal;
+}
+
+/* a literal value */
+.lit {
+  color: #006400;
+  font-weight: normal;
+  font-style: normal;
+}
+
+/* punctuation */
+.pun {
+  color: #000000;
+  font-weight: bold;
+  font-style: normal;
+}
+
+/* lisp open bracket */
+.opn {
+  color: #000000;
+  font-weight: bold;
+  font-style: normal;
+}
+
+/* lisp close bracket */
+.clo {
+  color: #000000;
+  font-weight: bold;
+  font-style: normal;
+}
+
+/* a markup tag name */
+.tag {
+  color: #006400;
+  font-weight: normal;
+  font-style: normal;
+}
+
+/* a markup attribute name */
+.atn {
+  color: #006400;
+  font-weight: normal;
+  font-style: normal;
+}
+
+/* a markup attribute value */
+.atv {
+  color: #006400;
+  font-weight: normal;
+  font-style: normal;
+}
+
+/* a declaration */
+.dec {
+  color: #000000;
+  font-weight: bold;
+  font-style: normal;
+}
+
+/* a variable name */
+.var {
+  color: #000000;
+  font-weight: normal;
+  font-style: normal;
+}
+
+/* a function name */
+.fun {
+  color: #000000;
+  font-weight: bold;
+  font-style: normal;
+}
+
+/* Specify class=linenums on a pre to get line numbering */
+ol.linenums {
+  margin-top: 0;
+  margin-bottom: 0;
+}

package/static/styles/prettify-tomorrow.css

@@ -0,0 +1,138 @@
+/* Tomorrow Theme */
+/* Original theme - https://github.com/chriskempson/tomorrow-theme */
+/* Pretty printing styles. Used with prettify.js. */
+/* SPAN elements with the classes below are added by prettyprint. */
+/* plain text */
+.pln {
+  color: #4d4d4c; }
+
+@media screen {
+  /* string content */
+  .str {
+    color: hsl(104, 100%, 24%); }
+
+  /* a keyword */
+  .kwd {
+    color: hsl(240, 100%, 50%); }
+
+  /* a comment */
+  .com {
+    color: hsl(0, 0%, 60%); }
+
+  /* a type name */
+  .typ {
+    color: hsl(240, 100%, 32%); }
+
+  /* a literal value */
+  .lit {
+    color: hsl(240, 100%, 40%); }
+
+  /* punctuation */
+  .pun {
+    color: #000000; }
+
+  /* lisp open bracket */
+  .opn {
+    color: #000000; }
+
+  /* lisp close bracket */
+  .clo {
+    color: #000000; }
+
+  /* a markup tag name */
+  .tag {
+    color: #c82829; }
+
+  /* a markup attribute name */
+  .atn {
+    color: #f5871f; }
+
+  /* a markup attribute value */
+  .atv {
+    color: #3e999f; }
+
+  /* a declaration */
+  .dec {
+    color: #f5871f; }
+
+  /* a variable name */
+  .var {
+    color: #c82829; }
+
+  /* a function name */
+  .fun {
+    color: #4271ae; } }
+/* Use higher contrast and text-weight for printable form. */
+@media print, projection {
+  .str {
+    color: #060; }
+
+  .kwd {
+    color: #006;
+    font-weight: bold; }
+
+  .com {
+    color: #600;
+    font-style: italic; }
+
+  .typ {
+    color: #404;
+    font-weight: bold; }
+
+  .lit {
+    color: #044; }
+
+  .pun, .opn, .clo {
+    color: #440; }
+
+  .tag {
+    color: #006;
+    font-weight: bold; }
+
+  .atn {
+    color: #404; }
+
+  .atv {
+    color: #060; } }
+/* Style */
+/*
+pre.prettyprint {
+  background: white;
+  font-family: Consolas, Monaco, 'Andale Mono', monospace;
+  font-size: 12px;
+  line-height: 1.5;
+  border: 1px solid #ccc;
+  padding: 10px; }
+*/
+
+/* Get LI elements to show when they are in the main article */
+article ul li {
+  list-style-type: circle;
+  margin-left: 25px;
+}
+
+/* Specify class=linenums on a pre to get line numbering */
+ol.linenums {
+  margin-top: 0;
+  margin-bottom: 0; }
+
+/* IE indents via margin-left */
+li.L0,
+li.L1,
+li.L2,
+li.L3,
+li.L4,
+li.L5,
+li.L6,
+li.L7,
+li.L8,
+li.L9 {
+  /* */ }
+
+/* Alternate shading for lines */
+li.L1,
+li.L3,
+li.L5,
+li.L7,
+li.L9 {
+  /* */ }

package/tmpl/augments.tmpl

@@ -0,0 +1,10 @@
+<?js
+  var data = obj;
+  var self = this;
+?>
+
+<?js if (data.augments && data.augments.length) { ?>
+  <ul><?js data.augments.forEach(function(a) { ?>
+    <li><?js= self.linkto(a, a) ?></li>
+  <?js }) ?></ul>
+<?js } ?>

package/tmpl/container.tmpl

@@ -0,0 +1,213 @@
+<?js
+  var self = this;
+  var conf = env.conf;
+  var isGlobalPage;
+
+  docs.forEach(function(doc, i) {
+    isGlobalPage = isGlobalPage || doc.kind === 'globalobj';
+
+    if (doc.kind === 'mainpage' || (doc.kind === 'package')) { ?>
+      <?js= self.partial('mainpage.tmpl', doc) ?>
+    <?js } else if (doc.kind === 'source') { ?>
+      <?js= self.partial('source.tmpl', doc) ?>
+    <?js } else { ?>
+
+<section>
+  <header>
+    <?js if (!doc.longname || doc.kind !== 'module') { ?>
+      <h2>
+        <?js if (doc.ancestors && doc.ancestors.length) { ?>
+          <span class="ancestors"><?js= doc.ancestors.join('') ?></span>
+        <?js } ?>
+        <?js= doc.name ?>
+        <?js if (doc.variation) { ?>
+          <sup class="variation"><?js= doc.variation ?></sup>
+        <?js } ?>
+      </h2>
+
+      <?js if (doc.classdesc) { ?>
+        <div class="class-description">
+          <?js= doc.classdesc ?>
+        </div>
+      <?js } ?>
+    <?js } else if (doc.kind === 'module' && doc.modules) { ?>
+      <?js doc.modules.forEach(function(module) { ?>
+        <?js if (module.classdesc) { ?>
+          <div class="class-description">
+            <?js= module.classdesc ?>
+          </div>
+        <?js }
+      })
+    } ?>
+  </header>
+
+  <article>
+    <div class="container-overview">
+      <?js if (doc.kind === 'module' && doc.modules) { ?>
+        <?js if (doc.description) { ?>
+          <div class="description">
+            <?js= doc.description ?>
+          </div>
+        <?js } ?>
+
+        <?js doc.modules.forEach(function(module) { ?>
+          <?js= self.partial('method.tmpl', module) ?>
+        <?js }) ?>
+      <?js } else if (doc.kind === 'class') { ?>
+        <?js= self.partial('method.tmpl', doc) ?>
+      <?js } else { ?>
+        <?js if (doc.description) { ?>
+            <div class="description">
+              <?js= doc.description ?>
+            </div>
+        <?js } ?>
+
+        <?js= self.partial('details.tmpl', doc) ?>
+
+        <?js if (doc.examples && doc.examples.length) { ?>
+          <h3>Example<?js= doc.examples.length > 1? 's':'' ?></h3>
+          <?js= self.partial('examples.tmpl', doc.examples) ?>
+        <?js } ?>
+      <?js } ?>
+    </div>
+
+    <?js if (doc.augments && doc.augments.length) { ?>
+      <h3 class="subsection-title">Extends</h3>
+
+      <?js= self.partial('augments.tmpl', doc) ?>
+    <?js } ?>
+
+    <?js if (doc.requires && doc.requires.length) { ?>
+      <h3 class="subsection-title">Requires</h3>
+
+      <ul>
+        <?js doc.requires.forEach(function(r) { ?>
+          <li>
+            <?js= self.linkto(r, r) ?>
+          </li>
+        <?js }); ?>
+      </ul>
+    <?js } ?>
+
+    <?js
+      var classes = self.find({kind: 'class', memberof: doc.longname});
+      if (!isGlobalPage && classes && classes.length) {
+    ?>
+      <h3 class="subsection-title">Classes</h3>
+
+      <dl>
+        <?js classes.forEach(function(c) { ?>
+          <dt>
+            <?js= self.linkto(c.longname, c.name) ?>
+          </dt>
+          <dd>
+            <?js if (c.summary) { ?>
+              <?js= c.summary ?>
+            <?js } ?>
+          </dd>
+        <?js }); ?>
+      </dl>
+    <?js } ?>
+
+     <?js
+        var mixins = self.find({kind: 'mixin', memberof: doc.longname});
+
+        if (!isGlobalPage && mixins && mixins.length) {
+     ?>
+       <h3 class="subsection-title">Mixins</h3>
+
+       <dl>
+         <?js mixins.forEach(function(m) { ?>
+           <dt>
+             <?js= self.linkto(m.longname, m.name) ?>
+           </dt>
+           <dd>
+             <?js if (m.summary) { ?><?js= m.summary ?><?js } ?>
+           </dd>
+         <?js }); ?>
+       </dl>
+    <?js } ?>
+
+    <?js
+      var namespaces = self.find({kind: 'namespace', memberof: doc.longname});
+      if (!isGlobalPage && namespaces && namespaces.length) {
+    ?>
+      <h3 class="subsection-title">Namespaces</h3>
+
+      <dl>
+        <?js namespaces.forEach(function(n) { ?>
+          <dt>
+            <?js= self.linkto(n.longname, n.name) ?>
+          </dt>
+          <dd>
+            <?js if (n.summary) { ?><?js= n.summary ?><?js } ?>
+          </dd>
+        <?js }); ?>
+      </dl>
+    <?js } ?>
+
+    <?js
+      var members = self.find({kind: 'member', memberof: isGlobalPage ? {isUndefined: true} : doc.longname});
+      var excludePattern = new RegExp(conf.source.excludePattern);
+
+      // symbols that are assigned to module.exports are not globals, even though they're not a memberof anything
+      if (isGlobalPage && members && members.length && members.forEach) {
+        members = members.filter(function(m) {
+          return m.longname && m.longname.indexOf('module:') !== 0;
+        });
+      }
+
+      if (members && members.length && members.forEach) {
+  ?>
+        <h3 class="subsection-title">Members</h3>
+
+        <?js members.forEach(function(p) {
+          if (!conf.source.excludePattern || !p.comment.match(excludePattern)) { ?>
+            <?js= self.partial('members.tmpl', p) ?>
+          <?js } ?>
+        <?js }); ?>
+    <?js } ?>
+
+    <?js
+      var methods = self.find({kind: 'function', memberof: isGlobalPage ? {isUndefined: true} : doc.longname});
+      if (methods && methods.length && methods.forEach) {
+    ?>
+      <h3 class="subsection-title">Methods</h3>
+
+      <?js methods.forEach(function(m) { ?>
+        <?js= self.partial('method.tmpl', m) ?>
+      <?js }); ?>
+    <?js } ?>
+
+    <?js
+      var typedefs = self.find({kind: 'typedef', memberof: isGlobalPage ? {isUndefined: true} : doc.longname});
+
+      if (typedefs && typedefs.length && typedefs.forEach) {
+    ?>
+      <h3 class="subsection-title">Type Definitions</h3>
+
+      <?js typedefs.forEach(function(e) {
+        if (e.signature) {
+      ?>
+          <?js= self.partial('method.tmpl', e) ?>
+        <?js } else { ?>
+          <?js= self.partial('members.tmpl', e) ?>
+        <?js }
+      }); 
+    } ?>
+
+    <?js
+      var events = self.find({kind: 'event', memberof: isGlobalPage ? {isUndefined: true} : doc.longname});
+      if (events && events.length && events.forEach) {
+    ?>
+      <h3 class="subsection-title">Events</h3>
+
+      <?js events.forEach(function(e) { ?>
+        <?js= self.partial('method.tmpl', e) ?>
+      <?js }); ?>
+    <?js } ?>
+  </article>
+</section>
+
+<?js } ?>
+<?js }); ?>

package/tmpl/details.tmpl

@@ -0,0 +1,223 @@
+<?js
+  var data = obj;
+  var self = this;
+  var defaultObjectClass = '';
+
+  // Check if the default value is an object or array; if so, apply code highlighting
+  if (data.defaultvalue && (data.defaultvaluetype === 'object' || data.defaultvaluetype === 'array')) {
+    data.defaultvalue = "<pre class=\"prettyprint\"><code>" + data.defaultvalue + "</code></pre>";
+    defaultObjectClass = ' class="object-value"';
+  }
+
+  var properties = data.properties;
+
+  if (properties && properties.length && properties.forEach) {
+?>
+
+  <h5 class="subsection-title">Properties:</h5>
+
+  <?js= this.partial('properties.tmpl', data) ?>
+
+<?js } ?>
+
+<dl class="details">
+
+  <?js if (data.version) {?>
+    <dt class="tag-version">Version:</dt>
+    <dd class="tag-version">
+      <ul class="dummy">
+        <li>
+          <?js= version ?>
+        </li>
+      </ul>
+    </dd>
+  <?js } ?>
+
+  <?js if (data.since) {?>
+    <dt class="tag-since">Since:</dt>
+    <dd class="tag-since">
+      <ul class="dummy">
+        <li>
+          <?js= since ?>
+        </li>
+      </ul>
+    </dd>
+  <?js } ?>
+
+  <?js if (data.inherited && data.inherits && !data.overrides) { ?>
+    <dt class="inherited-from">Inherited From:</dt>
+    <dd class="inherited-from">
+      <ul class="dummy">
+        <li>
+          <?js= this.linkto(data.inherits, this.htmlsafe(data.inherits)) ?>
+        </li>
+      </ul>
+    </dd>
+  <?js } ?>
+
+  <?js if (data.overrides) { ?>
+    <dt class="tag-overrides">Overrides:</dt>
+    <dd class="tag-overrides">
+      <ul class="dummy">
+        <li>
+          <?js= this.linkto(data.overrides, this.htmlsafe(data.overrides)) ?>
+        </li>
+      </ul>
+    </dd>
+  <?js } ?>
+
+  <?js if (data.implementations && data.implementations.length) { ?>
+    <dt class="implementations">Implementations:</dt>
+    <dd class="implementations">
+      <ul>
+        <?js data.implementations.forEach(function(impl) { ?>
+          <li>
+            <?js= self.linkto(impl, self.htmlsafe(impl)) ?>
+          </li>
+        <?js }); ?>
+      </ul>
+    </dd>
+  <?js } ?>
+
+  <?js if (data.implements && data.implements.length) { ?>
+    <dt class="implements">Implements:</dt>
+    <dd class="implements">
+      <ul>
+        <?js data.implements.forEach(function(impl) { ?>
+          <li><?js= self.linkto(impl, self.htmlsafe(impl)) ?></li>
+        <?js }); ?>
+      </ul>
+    </dd>
+  <?js } ?>
+
+  <?js if (data.mixes && data.mixes.length) { ?>
+    <dt class="mixes">Mixes In:</dt>
+
+    <dd class="mixes">
+      <ul>
+        <?js data.mixes.forEach(function(a) { ?>
+          <li>
+            <?js= self.linkto(a, a) ?>
+          </li>
+        <?js }); ?>
+      </ul>
+    </dd>
+  <?js } ?>
+
+  <?js if (data.deprecated) { ?>
+    <dt class="important tag-deprecated">Deprecated:</dt>
+    <?js
+      if (data.deprecated === true) { ?>
+        <dd class="yes-def tag-deprecated">
+          <ul class="dummy">
+            <li>Yes</li>
+          </ul>
+        </dd>
+      <?js } else { ?>
+        <dd>
+          <ul class="dummy">
+            <li>
+              <?js= data.deprecated ?>
+            </li>
+          </ul>
+        </dd>
+      <?js } ?>
+    <br>
+  <?js } ?>
+
+  <?js if (data.author && author.length) {?>
+    <dt class="tag-author">Author:</dt>
+    <dd class="tag-author">
+      <ul>
+        <?js author.forEach(function(a) { ?>
+          <li>
+            <?js= self.resolveAuthorLinks(a) ?>
+          </li>
+        <?js }); ?>
+      </ul>
+    </dd>
+  <?js } ?>
+
+  <?js if (data.copyright) {?>
+    <dt class="tag-copyright">Copyright:</dt>
+    <dd class="tag-copyright">
+      <ul class="dummy">
+        <li>
+          <?js= copyright ?>
+        </li>
+      </ul>
+    </dd>
+  <?js } ?>
+
+  <?js if (data.license) {?>
+    <dt class="tag-license">License:</dt>
+    <dd class="tag-license">
+      <ul class="dummy">
+        <li>
+          <?js= license ?>
+        </li>
+      </ul>
+    </dd>
+  <?js } ?>
+
+  <?js if (data.defaultvalue) {?>
+    <dt class="tag-default">Default Value:</dt>
+    <dd class="tag-default">
+      <ul class="dummy">
+        <li<?js= defaultObjectClass ?>>
+          <?js= data.defaultvalue ?>
+        </li>
+      </ul>
+    </dd>
+  <?js } ?>
+
+  <?js if (data.meta && self.outputSourceFiles) {?>
+    <dt class="tag-source">Source:</dt>
+    <dd class="tag-source">
+      <ul class="dummy">
+        <li>
+          <?js= self.linkto(meta.shortpath) ?>, <?js= self.linkto(meta.shortpath, 'line ' + meta.lineno, null, 'line' + meta.lineno) ?>
+        </li>
+      </ul>
+    </dd>
+  <?js } ?>
+
+  <?js if (data.tutorials && tutorials.length) {?>
+    <dt class="tag-tutorial">Tutorials:</dt>
+    <dd class="tag-tutorial">
+      <ul>
+        <?js tutorials.forEach(function(t) { ?>
+          <li>
+            <?js= self.tutoriallink(t) ?>
+          </li>
+        <?js }); ?>
+      </ul>
+    </dd>
+  <?js } ?>
+
+  <?js if (data.see && see.length) {?>
+    <dt class="tag-see">See:</dt>
+    <dd class="tag-see">
+      <ul>
+        <?js see.forEach(function(s) { ?>
+          <li>
+            <?js= self.linkto(s) ?>
+          </li>
+        <?js }); ?>
+      </ul>
+    </dd>
+  <?js } ?>
+
+  <?js if (data.todo && todo.length) {?>
+    <dt class="tag-todo">To Do:</dt>
+    <dd class="tag-todo">
+      <ul>
+        <?js todo.forEach(function(t) { ?>
+          <li>
+            <?js= t ?>
+          </li>
+        <?js }); ?>
+      </ul>
+    </dd>
+  <?js } ?>
+</dl>

package/tmpl/example.tmpl

@@ -0,0 +1,2 @@
+<?js var data = obj; ?>
+<pre><code><?js= data ?></code></pre>

package/tmpl/examples.tmpl

@@ -0,0 +1,14 @@
+<?js
+  var data = obj;
+  var self = this;
+
+  data.forEach(function(example) {
+    if (example.caption) { 
+?>
+  <p class="code-caption">
+    <?js= example.caption ?>
+  </p>
+<?js } ?>
+
+  <pre class="prettyprint"><code><?js= self.htmlsafe(example.code) ?></code></pre>
+<?js }); ?>