CustomError.js.html 6.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139
  1. <!-- start:source.tmpl.hbs -->
  2. <!DOCTYPE html>
  3. <html lang="en">
  4. <head>
  5. <meta charset="utf-8">
  6. <meta name="viewport" content="width=device-width">
  7. <title>CustomError.js</title>
  8. <!--[if lt IE 9]>
  9. <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
  10. <![endif]-->
  11. <link href="https://fonts.googleapis.com/css?family=PT+Mono" rel="stylesheet">
  12. <link type="text/css" rel="stylesheet" href="css/bootstrap.min.css">
  13. <link type="text/css" rel="stylesheet" href="css/prism.min.css">
  14. <link type="text/css" rel="stylesheet" href="css/template.min.css">
  15. <script type="text/javascript">
  16. 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};
  17. window.DOCLET_TOC_ENABLED = false;
  18. window.DOCLET_AFILTER_ENABLED = false;
  19. </script>
  20. </head>
  21. <body>
  22. <!-- start:navbar.hbs -->
  23. <header class="navbar navbar-default navbar-fixed-top navbar-inverse">
  24. <div class="container">
  25. <div class="navbar-header">
  26. <a class="navbar-brand" href="index.html">
  27. FooDoc
  28. </a>
  29. <!-- displayed on small devices -->
  30. <button class="navbar-toggle" type="button" data-toggle="collapse" data-target="#topNavigation">
  31. <span class="icon-bar"></span>
  32. <span class="icon-bar"></span>
  33. <span class="icon-bar"></span>
  34. </button>
  35. </div>
  36. <div class="navbar-collapse collapse" id="topNavigation">
  37. <ul class="nav navbar-nav">
  38. <li class="dropdown">
  39. <a href="global.html" class="dropdown-toggle" data-toggle="dropdown">Globals<b class="caret"></b></a>
  40. <ul class="dropdown-menu">
  41. <li><a href="global.html#SomeType">SomeType</a></li>
  42. </ul>
  43. </li>
  44. <li class="dropdown">
  45. <a href="list_class.html" class="dropdown-toggle" data-toggle="dropdown">Classes<b class="caret"></b></a>
  46. <ul class="dropdown-menu">
  47. <li><a href="CustomError.html">CustomError</a></li>
  48. <li><a href="GlobalClass.html">GlobalClass</a></li>
  49. <li><a href="MyApi.Child.html">MyApi.Child</a></li>
  50. <li><a href="MyApi.Class.html">MyApi.Class</a></li>
  51. </ul>
  52. </li>
  53. <li class="dropdown">
  54. <a href="list_namespace.html" class="dropdown-toggle" data-toggle="dropdown">Namespaces<b class="caret"></b></a>
  55. <ul class="dropdown-menu">
  56. <li><a href="MyApi.html">MyApi</a></li>
  57. <li><a href="MyApi.utils.html">MyApi.utils</a></li>
  58. </ul>
  59. </li>
  60. <li class="dropdown">
  61. <a href="list_tutorial.html" class="dropdown-toggle" data-toggle="dropdown">Tutorials<b class="caret"></b></a>
  62. <ul class="dropdown-menu">
  63. <li><a href="tutorial-brush-teeth.html">Brush Teeth</a></li>
  64. <li><a href="tutorial-drive-car.html">Drive Car</a></li>
  65. </ul>
  66. </li>
  67. </ul>
  68. <!-- start:lunr-search-navbar.hbs -->
  69. <form class="navbar-form navbar-right" role="search">
  70. <div class="input-group">
  71. <input type="text" class="form-control" placeholder="Search" id="lunr-search-input">
  72. <div class="input-group-btn">
  73. <button class="btn btn-default" id="lunr-search-submit">
  74. <i class="glyphicon glyphicon-search"></i>
  75. </button>
  76. </div>
  77. </div>
  78. </form>
  79. <!-- start:lunr-search-navbar.hbs --> </div>
  80. </div>
  81. </header>
  82. <!-- end:navbar.hbs --> <div class="page-header">
  83. <div class="container">
  84. <span class="kind">source</span>
  85. <h1><span class="name">CustomError.js</span></h1>
  86. </div>
  87. </div>
  88. <div class="container content">
  89. <div class="row">
  90. <div class="col-md-12 main-content">
  91. <section class="source-section">
  92. <article></article>
  93. <pre class="prettyprint source language-javascript line-numbers"><code class="language-javascript">/**
  94. * @summary A global custom error.
  95. * @constructor CustomError
  96. * @param {string} message - The message for the error.
  97. * @description As this is just a test file there is no implementation of inheriting the Error.prototype or fixing of the stack trace, this is a dummy dummy object to test the documentation.
  98. * @extends {Error} The default `Error` object.
  99. * @example {@caption Use this class like any standard error object.}
  100. * throw new CustomError("Oh no! It broke :(");
  101. */
  102. function CustomError(message){
  103. this.name = "CustomError";
  104. this.message = message;
  105. }</code></pre>
  106. </section>
  107. </div>
  108. </div>
  109. </div>
  110. <footer>
  111. <div class="copyright">FooDoc Copyright © 2016 The contributors to the JSDoc3 and FooDoc projects.</div>
  112. <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>
  113. </footer>
  114. <script src="js/jquery.min.js"></script>
  115. <script src="js/bootstrap.min.js"></script>
  116. <script src="js/clipboard.min.js"></script>
  117. <script src="js/prism.min.js"></script>
  118. <script src="js/template.min.js"></script>
  119. <!-- start:lunr-search-modal.hbs -->
  120. <div class="modal fade" id="lunr-search-modal">
  121. <div class="modal-dialog">
  122. <div class="modal-content">
  123. <div class="modal-header">
  124. <button type="button" class="close" data-dismiss="modal" aria-label="Close"><span aria-hidden="true">&times;</span></button>
  125. <h4 class="modal-title">Search results</h4>
  126. </div>
  127. <div class="modal-body" id="lunr-search-body">
  128. </div>
  129. <div class="modal-footer" id="lunr-search-footer">
  130. <button type="button" class="btn btn-default" data-dismiss="modal">Close</button>
  131. </div>
  132. </div><!-- /.modal-content -->
  133. </div><!-- /.modal-dialog -->
  134. </div>
  135. <!-- end:lunr-search-modal.hbs --> <script src="js/lunr.min.js"></script>
  136. </body>
  137. </html>
  138. <!-- end:source.tmpl.hbs -->