Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion about-block-inline-tags.html
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<head>
<meta charset="utf-8">
<meta name="description" content="Overview of block and inline JSDoc tags.">
<title>Use JSDoc: Block and inline tags</title>
<title>Block and inline tags &ndash; Use JSDoc</title>
<link rel="stylesheet" href="styles/usejsdoc.css">
<link rel="stylesheet" href="styles/prettify.css">
<link rel="stylesheet" href="styles/css3-github-ribbon.css">
Expand Down
2 changes: 1 addition & 1 deletion about-commandline.html
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<head>
<meta charset="utf-8">
<meta name="description" content="About command-line arguments to JSDoc.">
<title>Use JSDoc: Command-line arguments to JSDoc</title>
<title>Command-line arguments to JSDoc &ndash; Use JSDoc</title>
<link rel="stylesheet" href="styles/usejsdoc.css">
<link rel="stylesheet" href="styles/prettify.css">
<link rel="stylesheet" href="styles/css3-github-ribbon.css">
Expand Down
2 changes: 1 addition & 1 deletion about-configuring-default-template.html
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<head>
<meta charset="utf-8">
<meta name="description" content="How to configure the output from JSDoc&#39;s default template.">
<title>Use JSDoc: Configuring JSDoc&#39;s default template</title>
<title>Configuring JSDoc&#39;s default template &ndash; Use JSDoc</title>
<link rel="stylesheet" href="styles/usejsdoc.css">
<link rel="stylesheet" href="styles/prettify.css">
<link rel="stylesheet" href="styles/css3-github-ribbon.css">
Expand Down
4 changes: 2 additions & 2 deletions about-configuring-jsdoc.html
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<head>
<meta charset="utf-8">
<meta name="description" content="How to configure JSDoc using a configuration file.">
<title>Use JSDoc: Configuring JSDoc with a configuration file</title>
<title>Configuring JSDoc with a configuration file &ndash; Use JSDoc</title>
<link rel="stylesheet" href="styles/usejsdoc.css">
<link rel="stylesheet" href="styles/prettify.css">
<link rel="stylesheet" href="styles/css3-github-ribbon.css">
Expand Down Expand Up @@ -330,4 +330,4 @@ <h2 id="related-links">Related Links</h2>
</script>
</body>

</html>
</html>
2 changes: 1 addition & 1 deletion about-getting-started.html
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<head>
<meta charset="utf-8">
<meta name="description" content="A quick-start to documenting JavaScript with JSDoc.">
<title>Use JSDoc: Getting Started with JSDoc 3</title>
<title>Getting Started with JSDoc 3 &ndash; Use JSDoc</title>
<link rel="stylesheet" href="styles/usejsdoc.css">
<link rel="stylesheet" href="styles/prettify.css">
<link rel="stylesheet" href="styles/css3-github-ribbon.css">
Expand Down
2 changes: 1 addition & 1 deletion about-including-package.html
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<head>
<meta charset="utf-8">
<meta name="description" content="How to show package details in your documentation.">
<title>Use JSDoc: Including a Package File</title>
<title>Including a Package File &ndash; Use JSDoc</title>
<link rel="stylesheet" href="styles/usejsdoc.css">
<link rel="stylesheet" href="styles/prettify.css">
<link rel="stylesheet" href="styles/css3-github-ribbon.css">
Expand Down
2 changes: 1 addition & 1 deletion about-including-readme.html
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<head>
<meta charset="utf-8">
<meta name="description" content="How to include a README file in your documentation.">
<title>Use JSDoc: Including a README File</title>
<title>Including a README File &ndash; Use JSDoc</title>
<link rel="stylesheet" href="styles/usejsdoc.css">
<link rel="stylesheet" href="styles/prettify.css">
<link rel="stylesheet" href="styles/css3-github-ribbon.css">
Expand Down
4 changes: 2 additions & 2 deletions about-inline-tags.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,11 @@
<head>
<meta charset="utf-8">
<meta http-equiv="refresh" content="0; url=about-block-inline-tags.html">
<title>Redirecting...</title>
<title>Redirecting&hellip; &ndash; Use JSDoc</title>
<link rel="canonical" href="about-block-inline-tags.html">
</head>
<body>
<h1>Redirecting...</h1>
<h1>Redirecting&hellip;</h1>
<a href="about-block-inline-tags.html">If you are not redirected, click here.</a>
<script type="text/javascript">location='about-block-inline-tags.html'</script>
</body>
Expand Down
2 changes: 1 addition & 1 deletion about-license-jsdoc3.html
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<head>
<meta charset="utf-8">
<meta name="description" content="License information for JSDoc 3.">
<title>Use JSDoc: License</title>
<title>License &ndash; Use JSDoc</title>
<link rel="stylesheet" href="styles/usejsdoc.css">
<link rel="stylesheet" href="styles/prettify.css">
<link rel="stylesheet" href="styles/css3-github-ribbon.css">
Expand Down
2 changes: 1 addition & 1 deletion about-namepaths.html
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<head>
<meta charset="utf-8">
<meta name="description" content="A guide to using namepaths with JSDoc 3.">
<title>Use JSDoc: Using namepaths with JSDoc 3</title>
<title>Using namepaths with JSDoc 3 &ndash; Use JSDoc</title>
<link rel="stylesheet" href="styles/usejsdoc.css">
<link rel="stylesheet" href="styles/prettify.css">
<link rel="stylesheet" href="styles/css3-github-ribbon.css">
Expand Down
2 changes: 1 addition & 1 deletion about-plugins.html
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<head>
<meta charset="utf-8">
<meta name="description" content="How to create and use JSDoc plugins.">
<title>Use JSDoc: About JSDoc plugins</title>
<title>About JSDoc plugins &ndash; Use JSDoc</title>
<link rel="stylesheet" href="styles/usejsdoc.css">
<link rel="stylesheet" href="styles/prettify.css">
<link rel="stylesheet" href="styles/css3-github-ribbon.css">
Expand Down
2 changes: 1 addition & 1 deletion about-tutorials.html
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<head>
<meta charset="utf-8">
<meta name="description" content="Adding tutorials to your API documentation.">
<title>Use JSDoc: Tutorials</title>
<title>Tutorials &ndash; Use JSDoc</title>
<link rel="stylesheet" href="styles/usejsdoc.css">
<link rel="stylesheet" href="styles/prettify.css">
<link rel="stylesheet" href="styles/css3-github-ribbon.css">
Expand Down
2 changes: 1 addition & 1 deletion howto-amd-modules.html
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<head>
<meta charset="utf-8">
<meta name="description" content="How to add JSDoc comments to AMD and RequireJS modules.">
<title>Use JSDoc: AMD Modules</title>
<title>AMD Modules &ndash; Use JSDoc</title>
<link rel="stylesheet" href="styles/usejsdoc.css">
<link rel="stylesheet" href="styles/prettify.css">
<link rel="stylesheet" href="styles/css3-github-ribbon.css">
Expand Down
2 changes: 1 addition & 1 deletion howto-commonjs-modules.html
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<head>
<meta charset="utf-8">
<meta name="description" content="How to add JSDoc comments to CommonJS and Node.js modules.">
<title>Use JSDoc: CommonJS Modules</title>
<title>CommonJS Modules &ndash; Use JSDoc</title>
<link rel="stylesheet" href="styles/usejsdoc.css">
<link rel="stylesheet" href="styles/prettify.css">
<link rel="stylesheet" href="styles/css3-github-ribbon.css">
Expand Down
2 changes: 1 addition & 1 deletion howto-es2015-classes.html
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<head>
<meta charset="utf-8">
<meta name="description" content="How to add JSDoc comments to ECMAScript 2015 classes.">
<title>Use JSDoc: ES 2015 Classes</title>
<title>ES 2015 Classes &ndash; Use JSDoc</title>
<link rel="stylesheet" href="styles/usejsdoc.css">
<link rel="stylesheet" href="styles/prettify.css">
<link rel="stylesheet" href="styles/css3-github-ribbon.css">
Expand Down
2 changes: 1 addition & 1 deletion howto-es2015-modules.html
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<head>
<meta charset="utf-8">
<meta name="description" content="How to add JSDoc comments to ECMAScript 2015 modules.">
<title>Use JSDoc: ES 2015 Modules</title>
<title>ES 2015 Modules &ndash; Use JSDoc</title>
<link rel="stylesheet" href="styles/usejsdoc.css">
<link rel="stylesheet" href="styles/prettify.css">
<link rel="stylesheet" href="styles/css3-github-ribbon.css">
Expand Down
2 changes: 1 addition & 1 deletion index.html
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<head>
<meta charset="utf-8">
<meta name="description" content="Official documentation for JSDoc 3.">
<title>Use JSDoc: Index</title>
<title>Index &ndash; Use JSDoc</title>
<link rel="stylesheet" href="styles/usejsdoc.css">
<link rel="stylesheet" href="styles/prettify.css">
<link rel="stylesheet" href="styles/css3-github-ribbon.css">
Expand Down
2 changes: 1 addition & 1 deletion plugins-markdown.html
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<head>
<meta charset="utf-8">
<meta name="description" content="Enable Markdown support in JSDoc.">
<title>Use JSDoc: Using the Markdown plugin</title>
<title>Using the Markdown plugin &ndash; Use JSDoc</title>
<link rel="stylesheet" href="styles/usejsdoc.css">
<link rel="stylesheet" href="styles/prettify.css">
<link rel="stylesheet" href="styles/css3-github-ribbon.css">
Expand Down
3 changes: 2 additions & 1 deletion styles/usejsdoc.css
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,8 @@ header a, header a:visited {
}

article {
margin: 18px;
margin: 18px auto;
max-width: 40em;
}

footer {
Expand Down
2 changes: 1 addition & 1 deletion tags-abstract.html
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<head>
<meta charset="utf-8">
<meta name="description" content="This member must be implemented (or overridden) by the inheritor.">
<title>Use JSDoc: @abstract</title>
<title>@abstract &ndash; Use JSDoc</title>
<link rel="stylesheet" href="styles/usejsdoc.css">
<link rel="stylesheet" href="styles/prettify.css">
<link rel="stylesheet" href="styles/css3-github-ribbon.css">
Expand Down
2 changes: 1 addition & 1 deletion tags-access.html
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<head>
<meta charset="utf-8">
<meta name="description" content="Specify the access level of this member (private, package-private, public, or protected).">
<title>Use JSDoc: @access</title>
<title>@access &ndash; Use JSDoc</title>
<link rel="stylesheet" href="styles/usejsdoc.css">
<link rel="stylesheet" href="styles/prettify.css">
<link rel="stylesheet" href="styles/css3-github-ribbon.css">
Expand Down
2 changes: 1 addition & 1 deletion tags-alias.html
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<head>
<meta charset="utf-8">
<meta name="description" content="Treat a member as if it had a different name.">
<title>Use JSDoc: @alias</title>
<title>@alias &ndash; Use JSDoc</title>
<link rel="stylesheet" href="styles/usejsdoc.css">
<link rel="stylesheet" href="styles/prettify.css">
<link rel="stylesheet" href="styles/css3-github-ribbon.css">
Expand Down
2 changes: 1 addition & 1 deletion tags-augments.html
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<head>
<meta charset="utf-8">
<meta name="description" content="Indicate that a symbol inherits from, and adds to, a parent symbol.">
<title>Use JSDoc: @augments</title>
<title>@augments &ndash; Use JSDoc</title>
<link rel="stylesheet" href="styles/usejsdoc.css">
<link rel="stylesheet" href="styles/prettify.css">
<link rel="stylesheet" href="styles/css3-github-ribbon.css">
Expand Down
2 changes: 1 addition & 1 deletion tags-author.html
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<head>
<meta charset="utf-8">
<meta name="description" content="Identify the author of an item.">
<title>Use JSDoc: @author</title>
<title>@author &ndash; Use JSDoc</title>
<link rel="stylesheet" href="styles/usejsdoc.css">
<link rel="stylesheet" href="styles/prettify.css">
<link rel="stylesheet" href="styles/css3-github-ribbon.css">
Expand Down
2 changes: 1 addition & 1 deletion tags-borrows.html
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<head>
<meta charset="utf-8">
<meta name="description" content="This object uses something from another object.">
<title>Use JSDoc: @borrows</title>
<title>@borrows &ndash; Use JSDoc</title>
<link rel="stylesheet" href="styles/usejsdoc.css">
<link rel="stylesheet" href="styles/prettify.css">
<link rel="stylesheet" href="styles/css3-github-ribbon.css">
Expand Down
2 changes: 1 addition & 1 deletion tags-callback.html
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<head>
<meta charset="utf-8">
<meta name="description" content="Document a callback function.">
<title>Use JSDoc: @callback</title>
<title>@callback &ndash; Use JSDoc</title>
<link rel="stylesheet" href="styles/usejsdoc.css">
<link rel="stylesheet" href="styles/prettify.css">
<link rel="stylesheet" href="styles/css3-github-ribbon.css">
Expand Down
2 changes: 1 addition & 1 deletion tags-class.html
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<head>
<meta charset="utf-8">
<meta name="description" content="This function is intended to be called with the &quot;new&quot; keyword.">
<title>Use JSDoc: @class</title>
<title>@class &ndash; Use JSDoc</title>
<link rel="stylesheet" href="styles/usejsdoc.css">
<link rel="stylesheet" href="styles/prettify.css">
<link rel="stylesheet" href="styles/css3-github-ribbon.css">
Expand Down
2 changes: 1 addition & 1 deletion tags-classdesc.html
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<head>
<meta charset="utf-8">
<meta name="description" content="Use the following text to describe the entire class.">
<title>Use JSDoc: @classdesc</title>
<title>@classdesc &ndash; Use JSDoc</title>
<link rel="stylesheet" href="styles/usejsdoc.css">
<link rel="stylesheet" href="styles/prettify.css">
<link rel="stylesheet" href="styles/css3-github-ribbon.css">
Expand Down
2 changes: 1 addition & 1 deletion tags-constant.html
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<head>
<meta charset="utf-8">
<meta name="description" content="Document an object as a constant.">
<title>Use JSDoc: @constant</title>
<title>@constant &ndash; Use JSDoc</title>
<link rel="stylesheet" href="styles/usejsdoc.css">
<link rel="stylesheet" href="styles/prettify.css">
<link rel="stylesheet" href="styles/css3-github-ribbon.css">
Expand Down
4 changes: 2 additions & 2 deletions tags-constructor.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,11 @@
<head>
<meta charset="utf-8">
<meta http-equiv="refresh" content="0; url=tags-class.html">
<title>Redirecting...</title>
<title>Redirecting&hellip; &ndash; Use JSDoc</title>
<link rel="canonical" href="tags-class.html">
</head>
<body>
<h1>Redirecting...</h1>
<h1>Redirecting&hellip;</h1>
<a href="tags-class.html">If you are not redirected, click here.</a>
<script type="text/javascript">location='tags-class.html'</script>
</body>
Expand Down
2 changes: 1 addition & 1 deletion tags-constructs.html
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<head>
<meta charset="utf-8">
<meta name="description" content="This function member will be the constructor for the previous class.">
<title>Use JSDoc: @constructs</title>
<title>@constructs &ndash; Use JSDoc</title>
<link rel="stylesheet" href="styles/usejsdoc.css">
<link rel="stylesheet" href="styles/prettify.css">
<link rel="stylesheet" href="styles/css3-github-ribbon.css">
Expand Down
2 changes: 1 addition & 1 deletion tags-copyright.html
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<head>
<meta charset="utf-8">
<meta name="description" content="Document some copyright information.">
<title>Use JSDoc: @copyright</title>
<title>@copyright &ndash; Use JSDoc</title>
<link rel="stylesheet" href="styles/usejsdoc.css">
<link rel="stylesheet" href="styles/prettify.css">
<link rel="stylesheet" href="styles/css3-github-ribbon.css">
Expand Down
2 changes: 1 addition & 1 deletion tags-default.html
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<head>
<meta charset="utf-8">
<meta name="description" content="Document the default value.">
<title>Use JSDoc: @default</title>
<title>@default &ndash; Use JSDoc</title>
<link rel="stylesheet" href="styles/usejsdoc.css">
<link rel="stylesheet" href="styles/prettify.css">
<link rel="stylesheet" href="styles/css3-github-ribbon.css">
Expand Down
2 changes: 1 addition & 1 deletion tags-deprecated.html
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<head>
<meta charset="utf-8">
<meta name="description" content="Document that this is no longer the preferred way.">
<title>Use JSDoc: @deprecated</title>
<title>@deprecated &ndash; Use JSDoc</title>
<link rel="stylesheet" href="styles/usejsdoc.css">
<link rel="stylesheet" href="styles/prettify.css">
<link rel="stylesheet" href="styles/css3-github-ribbon.css">
Expand Down
2 changes: 1 addition & 1 deletion tags-description.html
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<head>
<meta charset="utf-8">
<meta name="description" content="Describe a symbol.">
<title>Use JSDoc: @description</title>
<title>@description &ndash; Use JSDoc</title>
<link rel="stylesheet" href="styles/usejsdoc.css">
<link rel="stylesheet" href="styles/prettify.css">
<link rel="stylesheet" href="styles/css3-github-ribbon.css">
Expand Down
2 changes: 1 addition & 1 deletion tags-enum.html
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<head>
<meta charset="utf-8">
<meta name="description" content="Document a collection of related properties.">
<title>Use JSDoc: @enum</title>
<title>@enum &ndash; Use JSDoc</title>
<link rel="stylesheet" href="styles/usejsdoc.css">
<link rel="stylesheet" href="styles/prettify.css">
<link rel="stylesheet" href="styles/css3-github-ribbon.css">
Expand Down
2 changes: 1 addition & 1 deletion tags-event.html
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<head>
<meta charset="utf-8">
<meta name="description" content="Document an event.">
<title>Use JSDoc: @event</title>
<title>@event &ndash; Use JSDoc</title>
<link rel="stylesheet" href="styles/usejsdoc.css">
<link rel="stylesheet" href="styles/prettify.css">
<link rel="stylesheet" href="styles/css3-github-ribbon.css">
Expand Down
2 changes: 1 addition & 1 deletion tags-example.html
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<head>
<meta charset="utf-8">
<meta name="description" content="Provide an example of how to use a documented item.">
<title>Use JSDoc: @example</title>
<title>@example &ndash; Use JSDoc</title>
<link rel="stylesheet" href="styles/usejsdoc.css">
<link rel="stylesheet" href="styles/prettify.css">
<link rel="stylesheet" href="styles/css3-github-ribbon.css">
Expand Down
2 changes: 1 addition & 1 deletion tags-exports.html
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<head>
<meta charset="utf-8">
<meta name="description" content="Identify the member that is exported by a JavaScript module.">
<title>Use JSDoc: @exports</title>
<title>@exports &ndash; Use JSDoc</title>
<link rel="stylesheet" href="styles/usejsdoc.css">
<link rel="stylesheet" href="styles/prettify.css">
<link rel="stylesheet" href="styles/css3-github-ribbon.css">
Expand Down
2 changes: 1 addition & 1 deletion tags-external.html
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<head>
<meta charset="utf-8">
<meta name="description" content="Identifies an external class, namespace, or module.">
<title>Use JSDoc: @external</title>
<title>@external &ndash; Use JSDoc</title>
<link rel="stylesheet" href="styles/usejsdoc.css">
<link rel="stylesheet" href="styles/prettify.css">
<link rel="stylesheet" href="styles/css3-github-ribbon.css">
Expand Down
2 changes: 1 addition & 1 deletion tags-file.html
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<head>
<meta charset="utf-8">
<meta name="description" content="Describe a file.">
<title>Use JSDoc: @file</title>
<title>@file &ndash; Use JSDoc</title>
<link rel="stylesheet" href="styles/usejsdoc.css">
<link rel="stylesheet" href="styles/prettify.css">
<link rel="stylesheet" href="styles/css3-github-ribbon.css">
Expand Down
2 changes: 1 addition & 1 deletion tags-fires.html
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<head>
<meta charset="utf-8">
<meta name="description" content="Describe the events this method may fire.">
<title>Use JSDoc: @fires</title>
<title>@fires &ndash; Use JSDoc</title>
<link rel="stylesheet" href="styles/usejsdoc.css">
<link rel="stylesheet" href="styles/prettify.css">
<link rel="stylesheet" href="styles/css3-github-ribbon.css">
Expand Down
Loading