@braintree/jsdoc-template 4.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (55) hide show
  1. package/CHANGELOG.md +37 -0
  2. package/LICENSE +27 -0
  3. package/README.md +89 -0
  4. package/package.json +51 -0
  5. package/publish.js +676 -0
  6. package/static/fonts/OpenSans-Bold-webfont.eot +0 -0
  7. package/static/fonts/OpenSans-Bold-webfont.svg +1830 -0
  8. package/static/fonts/OpenSans-Bold-webfont.woff +0 -0
  9. package/static/fonts/OpenSans-BoldItalic-webfont.eot +0 -0
  10. package/static/fonts/OpenSans-BoldItalic-webfont.svg +1830 -0
  11. package/static/fonts/OpenSans-BoldItalic-webfont.woff +0 -0
  12. package/static/fonts/OpenSans-Italic-webfont.eot +0 -0
  13. package/static/fonts/OpenSans-Italic-webfont.svg +1830 -0
  14. package/static/fonts/OpenSans-Italic-webfont.woff +0 -0
  15. package/static/fonts/OpenSans-Light-webfont.eot +0 -0
  16. package/static/fonts/OpenSans-Light-webfont.svg +1831 -0
  17. package/static/fonts/OpenSans-Light-webfont.woff +0 -0
  18. package/static/fonts/OpenSans-LightItalic-webfont.eot +0 -0
  19. package/static/fonts/OpenSans-LightItalic-webfont.svg +1835 -0
  20. package/static/fonts/OpenSans-LightItalic-webfont.woff +0 -0
  21. package/static/fonts/OpenSans-Regular-webfont.eot +0 -0
  22. package/static/fonts/OpenSans-Regular-webfont.svg +1831 -0
  23. package/static/fonts/OpenSans-Regular-webfont.woff +0 -0
  24. package/static/fonts/OpenSans-Semibold-webfont.eot +0 -0
  25. package/static/fonts/OpenSans-Semibold-webfont.svg +1830 -0
  26. package/static/fonts/OpenSans-Semibold-webfont.ttf +0 -0
  27. package/static/fonts/OpenSans-Semibold-webfont.woff +0 -0
  28. package/static/fonts/OpenSans-SemiboldItalic-webfont.eot +0 -0
  29. package/static/fonts/OpenSans-SemiboldItalic-webfont.svg +1830 -0
  30. package/static/fonts/OpenSans-SemiboldItalic-webfont.ttf +0 -0
  31. package/static/fonts/OpenSans-SemiboldItalic-webfont.woff +0 -0
  32. package/static/icons/home.svg +4 -0
  33. package/static/icons/search.svg +4 -0
  34. package/static/scripts/linenumber.js +23 -0
  35. package/static/scripts/pagelocation.js +89 -0
  36. package/static/styles/collapse.css +27 -0
  37. package/static/styles/jsdoc-default.css +953 -0
  38. package/static/styles/prettify-jsdoc.css +111 -0
  39. package/static/styles/prettify-tomorrow.css +138 -0
  40. package/tmpl/augments.tmpl +10 -0
  41. package/tmpl/container.tmpl +213 -0
  42. package/tmpl/details.tmpl +223 -0
  43. package/tmpl/example.tmpl +2 -0
  44. package/tmpl/examples.tmpl +14 -0
  45. package/tmpl/exceptions.tmpl +28 -0
  46. package/tmpl/layout.tmpl +150 -0
  47. package/tmpl/mainpage.tmpl +9 -0
  48. package/tmpl/members.tmpl +38 -0
  49. package/tmpl/method.tmpl +128 -0
  50. package/tmpl/params.tmpl +125 -0
  51. package/tmpl/properties.tmpl +111 -0
  52. package/tmpl/returns.tmpl +17 -0
  53. package/tmpl/source.tmpl +9 -0
  54. package/tmpl/tutorial.tmpl +23 -0
  55. package/tmpl/type.tmpl +11 -0
@@ -0,0 +1,4 @@
1
+ <svg fill="#000000" height="24" viewBox="0 0 24 24" width="24" xmlns="http://www.w3.org/2000/svg">
2
+ <path d="M10 20v-6h4v6h5v-8h3L12 3 2 12h3v8z"/>
3
+ <path d="M0 0h24v24H0z" fill="none"/>
4
+ </svg>
@@ -0,0 +1,4 @@
1
+ <svg fill="#000000" height="24" viewBox="0 0 24 24" width="24" xmlns="http://www.w3.org/2000/svg">
2
+ <path d="M15.5 14h-.79l-.28-.27C15.41 12.59 16 11.11 16 9.5 16 5.91 13.09 3 9.5 3S3 5.91 3 9.5 5.91 16 9.5 16c1.61 0 3.09-.59 4.23-1.57l.27.28v.79l5 4.99L20.49 19l-4.99-5zm-6 0C7.01 14 5 11.99 5 9.5S7.01 5 9.5 5 14 7.01 14 9.5 11.99 14 9.5 14z"/>
3
+ <path d="M0 0h24v24H0z" fill="none"/>
4
+ </svg>
@@ -0,0 +1,23 @@
1
+ 'use strict';
2
+
3
+ (function () {
4
+ var lineId, lines, totalLines, anchorHash;
5
+ var source = document.getElementsByClassName('prettyprint source linenums');
6
+ var i = 0;
7
+ var lineNumber = 0;
8
+
9
+ if (source && source[0]) {
10
+ anchorHash = document.location.hash.substring(1);
11
+ lines = source[0].getElementsByTagName('li');
12
+ totalLines = lines.length;
13
+
14
+ for (; i < totalLines; i++) {
15
+ lineNumber++;
16
+ lineId = 'line' + lineNumber;
17
+ lines[i].id = lineId;
18
+ if (lineId === anchorHash) {
19
+ lines[i].className += ' selected';
20
+ }
21
+ }
22
+ }
23
+ })();
@@ -0,0 +1,89 @@
1
+ 'use strict';
2
+
3
+ $(document).ready(function () {
4
+ var currentSectionNav, target;
5
+
6
+ // If an anchor hash is in the URL highlight the menu item
7
+ highlightActiveHash();
8
+ // If a specific page section is in the URL highlight the menu item
9
+ highlightActiveSection();
10
+
11
+ // If a specific page section is in the URL scroll that section up to the top
12
+ currentSectionNav = $('#' + getCurrentSectionName() + '-nav');
13
+
14
+ if (currentSectionNav.position()) {
15
+ $('nav').scrollTop(currentSectionNav.position().top);
16
+ }
17
+
18
+ // function to scroll to anchor when clicking an anchor linl
19
+ $('a[href*="#"]:not([href="#"])').click(function () {
20
+ /* eslint-disable no-invalid-this */
21
+ if (location.pathname.replace(/^\//, '') === this.pathname.replace(/^\//, '') && location.hostname === this.hostname) {
22
+ target = $(this.hash);
23
+ target = target.length ? target : $('[name=' + this.hash.slice(1) + ']');
24
+ if (target.length) {
25
+ $('html, body').animate({
26
+ scrollTop: target.offset().top
27
+ }, 1000);
28
+ }
29
+ }
30
+ /* eslint-enable no-invalid-this */
31
+ });
32
+ });
33
+
34
+ // If a new anchor section is selected, change the hightlighted menu item
35
+ $(window).bind('hashchange', function (event) {
36
+ highlightActiveHash(event);
37
+ });
38
+
39
+ function highlightActiveHash(event) {
40
+ var oldUrl, oldSubSectionElement;
41
+
42
+ // check for and remove old hash active state
43
+ if (event && event.originalEvent.oldURL) {
44
+ oldUrl = event.originalEvent.oldURL;
45
+
46
+ if (oldUrl.indexOf('#') > -1) {
47
+ oldSubSectionElement = $('#' + getCurrentSectionName() + '-' + oldUrl.substring(oldUrl.indexOf('#') + 1) + '-nav');
48
+
49
+ if (oldSubSectionElement) {
50
+ oldSubSectionElement.removeClass('active');
51
+ }
52
+ }
53
+ }
54
+
55
+ if (getCurrentHashName()) {
56
+ $('#' + getCurrentSectionName() + '-' + getCurrentHashName() + '-nav').addClass('active');
57
+ }
58
+ }
59
+
60
+ function highlightActiveSection() {
61
+ var pageId = getCurrentSectionName();
62
+
63
+ $('#' + pageId + '-nav').addClass('active');
64
+ }
65
+
66
+ function getCurrentSectionName() {
67
+ var path = window.location.pathname;
68
+ var pageUrl = path.split('/').pop();
69
+
70
+ var sectionName = pageUrl.substring(0, pageUrl.indexOf('.'));
71
+
72
+ // remove the wodr module- if its in the url
73
+ sectionName = sectionName.replace('module-', '');
74
+
75
+ return sectionName;
76
+ }
77
+
78
+ function getCurrentHashName() {
79
+ var pageSubSectionId;
80
+ var pageSubSectionHash = window.location.hash;
81
+
82
+ if (pageSubSectionHash) {
83
+ pageSubSectionId = pageSubSectionHash.substring(1).replace('.', '');
84
+
85
+ return pageSubSectionId;
86
+ }
87
+
88
+ return false;
89
+ }
@@ -0,0 +1,27 @@
1
+ @media only screen and (min-width: 681px) {
2
+ nav > ul > li:hover .methods,
3
+ .active .methods {
4
+ display: block;
5
+ }
6
+
7
+ .methods {
8
+ display: none;
9
+ }
10
+
11
+ nav > ul > li {
12
+ padding: 20px 0;
13
+ }
14
+
15
+ nav > ul > li > a {
16
+ padding: 0;
17
+ }
18
+
19
+ nav > ul > li.active a {
20
+ margin-bottom: 10px;
21
+ }
22
+
23
+ nav > ul > li:hover > a,
24
+ nav > ul > li.active > a {
25
+ margin-bottom: 15px;
26
+ }
27
+ }