From 1f1036744a1b798bde669dd68ef897fe9f112fcf Mon Sep 17 00:00:00 2001 From: Tim Wright Date: Tue, 27 Sep 2016 08:48:15 -0400 Subject: [PATCH 1/3] added modified files --- about-block-inline-tags.html | 12 ++--- about-commandline.html | 69 +++++++++---------------- about-configuring-default-template.html | 3 +- about-configuring-jsdoc.html | 39 +++++--------- about-getting-started.html | 15 ++---- about-including-package.html | 9 ++-- about-including-readme.html | 9 ++-- about-license-jsdoc3.html | 3 +- about-namepaths.html | 27 ++++------ about-plugins.html | 30 ++++------- about-tutorials.html | 24 +++------ howto-amd-modules.html | 18 +++---- howto-commonjs-modules.html | 36 +++++-------- howto-es2015-classes.html | 12 ++--- howto-es2015-modules.html | 6 +-- index.html | 3 +- plugins-markdown.html | 33 ++++-------- scripts/html5shiv-printshiv.min.js | 4 +- scripts/html5shiv.min.js | 4 +- styles/usejsdoc.css | 2 +- tags-abstract.html | 6 +-- tags-access.html | 9 ++-- tags-alias.html | 18 +++---- tags-augments.html | 12 ++--- tags-author.html | 9 ++-- tags-borrows.html | 9 ++-- tags-callback.html | 12 ++--- tags-class.html | 9 ++-- tags-classdesc.html | 9 ++-- tags-constant.html | 9 ++-- tags-constructs.html | 12 ++--- tags-copyright.html | 6 +-- tags-default.html | 9 ++-- tags-deprecated.html | 9 ++-- tags-description.html | 12 ++--- tags-enum.html | 9 ++-- tags-event.html | 12 ++--- tags-example.html | 9 ++-- tags-exports.html | 21 +++----- tags-external.html | 18 +++---- tags-file.html | 6 +-- tags-fires.html | 9 ++-- tags-function.html | 12 ++--- tags-global.html | 6 +-- tags-ignore.html | 9 ++-- tags-implements.html | 9 ++-- tags-inheritdoc.html | 9 ++-- tags-inline-link.html | 12 ++--- tags-inline-tutorial.html | 9 ++-- tags-inner.html | 9 ++-- tags-instance.html | 9 ++-- tags-interface.html | 15 ++---- tags-kind.html | 12 ++--- tags-lends.html | 18 +++---- tags-license.html | 12 ++--- tags-listens.html | 9 ++-- tags-member.html | 12 ++--- tags-memberof.html | 18 +++---- tags-mixes.html | 12 ++--- tags-mixin.html | 9 ++-- tags-module.html | 18 +++---- tags-name.html | 9 ++-- tags-namespace.html | 15 ++---- tags-override.html | 6 +-- tags-param.html | 42 +++++---------- tags-private.html | 12 ++--- tags-property.html | 6 +-- tags-protected.html | 12 ++--- tags-public.html | 6 +-- tags-readonly.html | 9 ++-- tags-requires.html | 9 ++-- tags-returns.html | 12 ++--- tags-see.html | 12 ++--- tags-since.html | 9 ++-- tags-static.html | 9 ++-- tags-summary.html | 6 +-- tags-this.html | 6 +-- tags-throws.html | 21 +++----- tags-todo.html | 9 ++-- tags-tutorial.html | 6 +-- tags-type.html | 12 ++--- tags-typedef.html | 12 ++--- tags-variation.html | 9 ++-- tags-version.html | 6 +-- 84 files changed, 357 insertions(+), 709 deletions(-) diff --git a/about-block-inline-tags.html b/about-block-inline-tags.html index d45f01aa..351eba45 100644 --- a/about-block-inline-tags.html +++ b/about-block-inline-tags.html @@ -55,8 +55,7 @@

Examples

Shoe.prototype.setColor = function(color) { // ... }; - - +

You can use inline tags within a description, as shown above, or within a block tag, as shown below:

Inline tag used within a block tag
/**
@@ -68,8 +67,7 @@ 
Examples

 Shoe.prototype.setColor = function(color) {
     // ...
 };
-
-
+

When you use multiple block tags in a JSDoc comment, they must be separated by line breaks:

Multiple block tags separated by line breaks
/**
@@ -81,13 +79,11 @@ 
Examples

 Shoe.prototype.setLaceType = function(color, type) {
     // ...
 };
-
-
+