Fixes line-breaks in docs, externalizes jsdoc-fix

bigtimebuddy · bigtimebuddy · commit 595729ace065 · 2017-10-24T14:37:27.000-04:00
diff --git a/filters/advanced-bloom/src/AdvancedBloomFilter.js b/filters/advanced-bloom/src/AdvancedBloomFilter.js
@@ -5,7 +5,7 @@ import fragment from './advanced-bloom.frag';
 /**
  * The AdvancedBloomFilter applies a Bloom Effect to an object. Unlike the normal BloomFilter
  * this had some advanced controls for adjusting the look of the bloom. Note: this filter
- * is slower than normal BloomFilter.
+ * is slower than normal BloomFilter.<br>
  * ![original](../tools/screenshots/dist/original.png)![filter](../tools/screenshots/dist/advanced-bloom.png)
  *
  * @class
diff --git a/filters/ascii/src/AsciiFilter.js b/filters/ascii/src/AsciiFilter.js
@@ -9,7 +9,7 @@ import fragment from './ascii.frag';
  */
 
 /**
- * An ASCII filter.
+ * An ASCII filter.<br>
  * ![original](../tools/screenshots/dist/original.png)![filter](../tools/screenshots/dist/ascii.png)
  *
  * @class
diff --git a/filters/bloom/src/BloomFilter.js b/filters/bloom/src/BloomFilter.js
@@ -2,7 +2,7 @@ const {BlurXFilter, BlurYFilter, VoidFilter} = PIXI.filters;
 
 /**
  * The BloomFilter applies a Gaussian blur to an object.
- * The strength of the blur can be set for x- and y-axis separately.
+ * The strength of the blur can be set for x- and y-axis separately.<br>
  * ![original](../tools/screenshots/dist/original.png)![filter](../tools/screenshots/dist/bloom.png)
  *
  * @class
diff --git a/filters/bulge-pinch/src/BulgePinchFilter.js b/filters/bulge-pinch/src/BulgePinchFilter.js
@@ -7,7 +7,7 @@ import fragment from './bulgePinch.frag';
  */
 
 /**
- * Bulges or pinches the image in a circle.
+ * Bulges or pinches the image in a circle.<br>
  * ![original](../tools/screenshots/dist/original.png)![filter](../tools/screenshots/dist/bulge-pinch.gif)
  *
  * @class
diff --git a/filters/color-replace/src/ColorReplaceFilter.js b/filters/color-replace/src/ColorReplaceFilter.js
@@ -3,7 +3,7 @@ import fragment from './colorReplace.frag';
 
 /**
  * ColorReplaceFilter, originally by mishaa, updated by timetocode
- * http://www.html5gamedevs.com/topic/10640-outline-a-sprite-change-certain-colors/?p=69966
+ * http://www.html5gamedevs.com/topic/10640-outline-a-sprite-change-certain-colors/?p=69966<br>
  * ![original](../tools/screenshots/dist/original.png)![filter](../tools/screenshots/dist/color-replace.png)
  *
  * @class
diff --git a/filters/convolution/src/ConvolutionFilter.js b/filters/convolution/src/ConvolutionFilter.js
@@ -6,7 +6,7 @@ import fragment from './convolution.frag';
  * A convolution combines pixels in the input image with neighboring pixels to produce a new image.
  * A wide variety of image effects can be achieved through convolutions, including blurring, edge
  * detection, sharpening, embossing, and beveling. The matrix should be specified as a 9 point Array.
- * See http://docs.gimp.org/en/plug-in-convmatrix.html for more info.
+ * See http://docs.gimp.org/en/plug-in-convmatrix.html for more info.<br>
  * ![original](../tools/screenshots/dist/original.png)![filter](../tools/screenshots/dist/convolution.png)
  *
  * @class
diff --git a/filters/cross-hatch/src/CrossHatchFilter.js b/filters/cross-hatch/src/CrossHatchFilter.js
@@ -2,7 +2,7 @@ import {vertex} from '@tools/fragments';
 import fragment from './crosshatch.frag';
 
 /**
- * A Cross Hatch effect filter.
+ * A Cross Hatch effect filter.<br>
  * ![original](../tools/screenshots/dist/original.png)![filter](../tools/screenshots/dist/cross-hatch.png)
  *
  * @class
diff --git a/filters/dot/src/DotFilter.js b/filters/dot/src/DotFilter.js
@@ -8,7 +8,7 @@ import fragment from './dot.frag';
 
 /**
  * This filter applies a dotscreen effect making display objects appear to be made out of
- * black and white halftone dots like an old printer.
+ * black and white halftone dots like an old printer.<br>
  * ![original](../tools/screenshots/dist/original.png)![filter](../tools/screenshots/dist/dot.png)
  *
  * @class
diff --git a/filters/drop-shadow/src/DropShadowFilter.js b/filters/drop-shadow/src/DropShadowFilter.js
@@ -2,7 +2,7 @@ import {vertex} from '@tools/fragments';
 import fragment from './dropshadow.frag';
 
 /**
- * Drop shadow filter.
+ * Drop shadow filter.<br>
  * ![original](../tools/screenshots/dist/original.png)![filter](../tools/screenshots/dist/drop-shadow.png)
  * @class
  * @extends PIXI.Filter
diff --git a/filters/emboss/src/EmbossFilter.js b/filters/emboss/src/EmbossFilter.js
@@ -2,7 +2,7 @@ import {vertex} from '@tools/fragments';
 import fragment from './emboss.frag';
 
 /**
- * An RGB Split Filter.
+ * An RGB Split Filter.<br>
  * ![original](../tools/screenshots/dist/original.png)![filter](../tools/screenshots/dist/emboss.png)
  *
  * @class
diff --git a/filters/glow/src/GlowFilter.js b/filters/glow/src/GlowFilter.js
@@ -4,7 +4,7 @@ import fragment from './glow.frag';
 /**
  * GlowFilter, originally by mishaa
  * http://www.html5gamedevs.com/topic/12756-glow-filter/?hl=mishaa#entry73578
- * http://codepen.io/mishaa/pen/raKzrm
+ * http://codepen.io/mishaa/pen/raKzrm<br>
  * ![original](../tools/screenshots/dist/original.png)![filter](../tools/screenshots/dist/glow.png)
  *
  * @class
diff --git a/filters/multi-color-replace/src/MultiColorReplaceFilter.js b/filters/multi-color-replace/src/MultiColorReplaceFilter.js
@@ -3,7 +3,7 @@ import fragment from './multi-color-replace.frag';
 
 /**
  * Filter for replacing a color with another color. Similar to ColorReplaceFilter, but support multiple
- * colors.
+ * colors.<br>
  * ![original](../tools/screenshots/dist/original.png)![filter](../tools/screenshots/dist/multi-color-replace.png)
  * @class
  * @extends PIXI.Filter
diff --git a/filters/outline/src/OutlineFilter.js b/filters/outline/src/OutlineFilter.js
@@ -4,7 +4,7 @@ import fragment from './outline.frag';
 /**
  * OutlineFilter, originally by mishaa
  * http://www.html5gamedevs.com/topic/10640-outline-a-sprite-change-certain-colors/?p=69966
- * http://codepen.io/mishaa/pen/emGNRB
+ * http://codepen.io/mishaa/pen/emGNRB<br>
  * ![original](../tools/screenshots/dist/original.png)![filter](../tools/screenshots/dist/outline.png)
  *
  * @class
diff --git a/filters/pixelate/src/PixelateFilter.js b/filters/pixelate/src/PixelateFilter.js
@@ -2,7 +2,7 @@ import {vertex} from '@tools/fragments';
 import fragment from './pixelate.frag';
 
 /**
- * This filter applies a pixelate effect making display objects appear 'blocky'.
+ * This filter applies a pixelate effect making display objects appear 'blocky'.<br>
  * ![original](../tools/screenshots/dist/original.png)![filter](../tools/screenshots/dist/pixelate.png)
  *
  * @class
diff --git a/filters/rgb-split/src/RGBSplitFilter.js b/filters/rgb-split/src/RGBSplitFilter.js
@@ -2,7 +2,7 @@ import {vertex} from '@tools/fragments';
 import fragment from './rgb-split.frag';
 
 /**
- * An RGB Split Filter.
+ * An RGB Split Filter.<br>
  * ![original](../tools/screenshots/dist/original.png)![filter](../tools/screenshots/dist/rgb.png)
  *
  * @class
diff --git a/filters/shockwave/src/ShockwaveFilter.js b/filters/shockwave/src/ShockwaveFilter.js
@@ -4,7 +4,7 @@ import fragment from './shockwave.frag';
 /**
  * The ColorMatrixFilter class lets you apply a 4x4 matrix transformation on the RGBA
  * color and alpha values of every pixel on your displayObject to produce a result
- * with a new set of RGBA color and alpha values. It's pretty powerful!
+ * with a new set of RGBA color and alpha values. It's pretty powerful!<br>
  * ![original](../tools/screenshots/dist/original.png)![filter](../tools/screenshots/dist/shockwave.gif)
  *
  * @class
diff --git a/filters/tilt-shift/src/TiltShiftFilter.js b/filters/tilt-shift/src/TiltShiftFilter.js
@@ -7,7 +7,7 @@ import TiltShiftYFilter from './TiltShiftYFilter';
  */
 
 /**
- * A TiltShift Filter. Manages the pass of both a TiltShiftXFilter and TiltShiftYFilter.
+ * A TiltShift Filter. Manages the pass of both a TiltShiftXFilter and TiltShiftYFilter.<br>
  * ![original](../tools/screenshots/dist/original.png)![filter](../tools/screenshots/dist/tilt-shift.png)
  *
  * @class
diff --git a/filters/twist/src/TwistFilter.js b/filters/twist/src/TwistFilter.js
@@ -2,7 +2,7 @@ import {vertex} from '@tools/fragments';
 import fragment from './twist.frag';
 
 /**
- * This filter applies a twist effect making display objects appear twisted in the given direction.
+ * This filter applies a twist effect making display objects appear twisted in the given direction.<br>
  * ![original](../tools/screenshots/dist/original.png)![filter](../tools/screenshots/dist/twist.png)
  *
  * @class
diff --git a/filters/zoom-blur/src/ZoomBlurFilter.js b/filters/zoom-blur/src/ZoomBlurFilter.js
@@ -2,7 +2,7 @@ import vertex from './zoom-blur.vert';
 import fragment from './zoom-blur.frag';
 
 /**
- * The ZoomFilter applies a Zoom blur to an object.
+ * The ZoomFilter applies a Zoom blur to an object.<br>
  * ![original](../tools/screenshots/dist/original.png)![filter](../tools/screenshots/dist/zoom-blur.png)
  *
  * @class
diff --git a/package.json b/package.json
@@ -22,7 +22,7 @@
     "postpub": "npm run deploy"
   },
   "devDependencies": {
-    "@pixi/jsdoc-template": "^2.0.0",
+    "@pixi/jsdoc-template": "^2.2.0",
     "eslint": "^4.6.1",
     "gh-pages": "^0.11.0",
     "http-server": "^0.9.0",
diff --git a/scripts/jsdoc-fix.js b/scripts/jsdoc-fix.js
diff --git a/scripts/jsdoc.conf.json b/scripts/jsdoc.conf.json
@@ -10,7 +10,7 @@
     },
     "plugins": [
         "plugins/markdown",
-        "./scripts/jsdoc-fix"
+        "./node_modules/@pixi/jsdoc-template/plugins/es6-fix"
     ],
     "templates": {
         "cleverLinks": false,

Original file line number	Diff line number	Diff line change
`@@ -5,7 +5,7 @@ import fragment from './advanced-bloom.frag';`
`5`	`5`	`/**`
`6`	`6`	`* The AdvancedBloomFilter applies a Bloom Effect to an object. Unlike the normal BloomFilter`
`7`	`7`	`* this had some advanced controls for adjusting the look of the bloom. Note: this filter`
`8`		`- * is slower than normal BloomFilter.`
	`8`	`+ * is slower than normal BloomFilter.<br>`
`9`	`9`	`* ![original](../tools/screenshots/dist/original.png)![filter](../tools/screenshots/dist/advanced-bloom.png)`
`10`	`10`	`*`
`11`	`11`	`* @class`
Original file line number	Diff line number	Diff line change
`@@ -9,7 +9,7 @@ import fragment from './ascii.frag';`
`9`	`9`	`*/`
`10`	`10`
`11`	`11`	`/**`
`12`		`- * An ASCII filter.`
	`12`	`+ * An ASCII filter.<br>`
`13`	`13`	`* ![original](../tools/screenshots/dist/original.png)![filter](../tools/screenshots/dist/ascii.png)`
`14`	`14`	`*`
`15`	`15`	`* @class`
Original file line number	Diff line number	Diff line change
`@@ -2,7 +2,7 @@ const {BlurXFilter, BlurYFilter, VoidFilter} = PIXI.filters;`
`2`	`2`
`3`	`3`	`/**`
`4`	`4`	`* The BloomFilter applies a Gaussian blur to an object.`
`5`		`- * The strength of the blur can be set for x- and y-axis separately.`
	`5`	`+ * The strength of the blur can be set for x- and y-axis separately.<br>`
`6`	`6`	`* ![original](../tools/screenshots/dist/original.png)![filter](../tools/screenshots/dist/bloom.png)`
`7`	`7`	`*`
`8`	`8`	`* @class`
Original file line number	Diff line number	Diff line change
`@@ -7,7 +7,7 @@ import fragment from './bulgePinch.frag';`
`7`	`7`	`*/`
`8`	`8`
`9`	`9`	`/**`
`10`		`- * Bulges or pinches the image in a circle.`
	`10`	`+ * Bulges or pinches the image in a circle.<br>`
`11`	`11`	`* ![original](../tools/screenshots/dist/original.png)![filter](../tools/screenshots/dist/bulge-pinch.gif)`
`12`	`12`	`*`
`13`	`13`	`* @class`
Original file line number	Diff line number	Diff line change
`@@ -3,7 +3,7 @@ import fragment from './colorReplace.frag';`
`3`	`3`
`4`	`4`	`/**`
`5`	`5`	`* ColorReplaceFilter, originally by mishaa, updated by timetocode`
`6`		`- * http://www.html5gamedevs.com/topic/10640-outline-a-sprite-change-certain-colors/?p=69966`
	`6`	`+ * http://www.html5gamedevs.com/topic/10640-outline-a-sprite-change-certain-colors/?p=69966<br>`
`7`	`7`	`* ![original](../tools/screenshots/dist/original.png)![filter](../tools/screenshots/dist/color-replace.png)`
`8`	`8`	`*`
`9`	`9`	`* @class`
Original file line number	Diff line number	Diff line change
`@@ -6,7 +6,7 @@ import fragment from './convolution.frag';`
`6`	`6`	`* A convolution combines pixels in the input image with neighboring pixels to produce a new image.`
`7`	`7`	`* A wide variety of image effects can be achieved through convolutions, including blurring, edge`
`8`	`8`	`* detection, sharpening, embossing, and beveling. The matrix should be specified as a 9 point Array.`
`9`		`- * See http://docs.gimp.org/en/plug-in-convmatrix.html for more info.`
	`9`	`+ * See http://docs.gimp.org/en/plug-in-convmatrix.html for more info.<br>`
`10`	`10`	`* ![original](../tools/screenshots/dist/original.png)![filter](../tools/screenshots/dist/convolution.png)`
`11`	`11`	`*`
`12`	`12`	`* @class`
Original file line number	Diff line number	Diff line change
`@@ -2,7 +2,7 @@ import {vertex} from '@tools/fragments';`
`2`	`2`	`import fragment from './crosshatch.frag';`
`3`	`3`
`4`	`4`	`/**`
`5`		`- * A Cross Hatch effect filter.`
	`5`	`+ * A Cross Hatch effect filter.<br>`
`6`	`6`	`* ![original](../tools/screenshots/dist/original.png)![filter](../tools/screenshots/dist/cross-hatch.png)`
`7`	`7`	`*`
`8`	`8`	`* @class`
Original file line number	Diff line number	Diff line change
`@@ -8,7 +8,7 @@ import fragment from './dot.frag';`
`8`	`8`
`9`	`9`	`/**`
`10`	`10`	`* This filter applies a dotscreen effect making display objects appear to be made out of`
`11`		`- * black and white halftone dots like an old printer.`
	`11`	`+ * black and white halftone dots like an old printer.<br>`
`12`	`12`	`* ![original](../tools/screenshots/dist/original.png)![filter](../tools/screenshots/dist/dot.png)`
`13`	`13`	`*`
`14`	`14`	`* @class`
Original file line number	Diff line number	Diff line change
`@@ -2,7 +2,7 @@ import {vertex} from '@tools/fragments';`
`2`	`2`	`import fragment from './emboss.frag';`
`3`	`3`
`4`	`4`	`/**`
`5`		`- * An RGB Split Filter.`
	`5`	`+ * An RGB Split Filter.<br>`
`6`	`6`	`* ![original](../tools/screenshots/dist/original.png)![filter](../tools/screenshots/dist/emboss.png)`
`7`	`7`	`*`
`8`	`8`	`* @class`