jsdoc-plantuml - npm Package Compare versions

Comparing version 1.0.0 to 1.0.1

index.js

@@ -128,3 +128,3 @@ const env = require('jsdoc/env');
         onTagged: function(doclet, tag) {
-            doclet.plantUml = [];
+            if (!Array.isArray(doclet.plantUml)) doclet.plantUml = [];
             tag.srcFile = path.join(doclet.meta.path, doclet.meta.filename);
@@ -131,0 +131,0 @@ tag.value.description = '@startuml\n' + tag.value.description + '\n@enduml';

package.json

 {
   "name": "jsdoc-plantuml",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "jsdoc3 plugin to use plantuml inside javascript documentation",
@@ -5,0 +5,0 @@ "main": "./index.js",

README.md

@@ -23,6 +23,6 @@ # jsdoc-plantuml
 
-Attention - The `@startuml` tag must get one parameter - the filename to safe this uml diagram at.
+Attention - The `@startuml` tag must have one parameter - the filename to safe this uml diagram at.
 ```js
 /**
- *  my normal jsodc comments...
+ *  my normal jsdoc comments...
  *  and here i reference my image generated with <img src=filename.png">
@@ -39,8 +39,8 @@ *  inside generate html docs
 
-The filename given after `@startuml` can either we a relativ filename with or without paths or
+The filename given after `@startuml` can either be a relative filename with or without paths or
 an absolute filename. @startuml tags without filename are ignored by this plugin.
 
 The filename should either end with the graphic format needed (png, svg, eps) or with "puml"
-as format for the plant uml source code files. If puml is used here the defaultFormat from the
-configuration is used to determined the file format created.
+as format for the plant uml source code files. If puml is used the defaultFormat from the
+configuration is used to determined the image file format created.
 
@@ -57,3 +57,3 @@ * `@startuml <filename>` can contain paths, allowed file formats are "png, svg, eps, puml"
   ...
-  "plugins": [ "node_modules/jsdoc-plantuml"],
+  "plugins": [ "jsdoc-plantuml"],
   "plantuml": {
@@ -99,3 +99,3 @@ "puml": {
   ...
-  "plugins": [ "node_modules/jsdoc-plantuml"],
+  "plugins": [ "jsdoc-plantuml"],
   "plantuml": {
@@ -137,3 +137,3 @@ "puml": {
   ...
-  "plugins": [ "node_modules/jsdoc-plantuml"],
+  "plugins": [ "jsdoc-plantuml"],
   "plantuml": {
@@ -173,3 +173,3 @@ "puml": {
   ...
-  "plugins": [ "node_modules/jsdoc-plantuml"],
+  "plugins": [ "jsdoc-plantuml"],
   "plantuml": {
@@ -176,0 +176,0 @@ "puml": {

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Worsened metrics

Total package byte prevSize

16785

decreased by-0.07%

No dependency changes