dox - npm Package Compare versions

Comparing version 0.5.2 to 0.5.3

History.md

@@ -0,1 +1,7 @@
+0.5.3 / 2014-10-06
+==================
+
+* Add `--skipSingleStar` option to ignore `/* ... */` comments
+* Merge #106: make the other context regex like the general method one
+
 0.5.2 / 2014-10-05
@@ -2,0 +8,0 @@ ==================

lib/dox.js

@@ -57,2 +57,3 @@ /*!
     , raw = options.raw
+    , skipSingleStar = options.skipSingleStar
     , comment
@@ -73,3 +74,4 @@ , buf = ''
     // start comment
-    if (!withinMultiline && !withinSingle && !withinString && '/' == js[i] && '*' == js[i+1]) {
+    if (!withinMultiline && !withinSingle && !withinString &&
+        '/' == js[i] && '*' == js[i+1] && (!skipSingleStar || js[i+2] == '*')) {
       lineNumStarting = lineNum;
@@ -397,3 +399,3 @@ // code following previous comment
   // prototype method
-  } else if (/^([\w$]+)\.prototype\.([\w$]+)[ \t]*=[ \t]*function/.exec(str)) {
+  } else if (/^([\w$.]+)\.prototype\.([\w$]+)[ \t]*=[ \t]*function/.exec(str)) {
     return {
@@ -407,3 +409,3 @@ type: 'method'
   // prototype property
-  } else if (/^([\w$]+)\.prototype\.([\w$]+)[ \t]*=[ \t]*([^\n;]+)/.exec(str)) {
+  } else if (/^([\w$.]+)\.prototype\.([\w$]+)[ \t]*=[ \t]*([^\n;]+)/.exec(str)) {
     return {
@@ -472,3 +474,3 @@ type: 'property'
   // property
-  } else if (/^([\w$]+)\.([\w$]+)[ \t]*=[ \t]*([^\n;]+)/.exec(str)) {
+  } else if (/^([\w$.]+)\.([\w$]+)[ \t]*=[ \t]*([^\n;]+)/.exec(str)) {
     return {
@@ -475,0 +477,0 @@ type: 'property'

package.json

 {
   "name": "dox",
   "description": "Markdown / JSdoc documentation generator",
-  "version": "0.5.2",
+  "version": "0.5.3",
   "author": "TJ Holowaychuk <[e-mail]>",
@@ -6,0 +6,0 @@ "contributors": [

Readme.md

@@ -102,15 +102,19 @@ # Dox
 
-Options:
+  Options:
 
-  -h, --help     output usage information
-  -v, --version  output the version number
-  -d, --debug    output parsed comments for debugging
+    -h, --help                     output usage information
+    -V, --version                  output the version number
+    -r, --raw                      output "raw" comments, leaving the markdown intact
+    -a, --api                      output markdown readme documentation
+    -s, --skipPrefixes [prefixes]  skip comments prefixed with these prefixes, separated by commas
+    -d, --debug                    output parsed comments for debugging
+    -S, --skipSingleStar           set to false to ignore `/* ... */` comments
 
-Examples:
+  Examples:
 
-  # stdin
-  $ dox > myfile.json
+    # stdin
+    $ dox > myfile.json
 
-  # operates over stdio
-  $ dox < myfile.js > myfile.json
+    # operates over stdio
+    $ dox < myfile.js > myfile.json
 
@@ -139,2 +143,5 @@ ```
     - isPrivate
+    - isEvent
+    - isConstructor
+    - line
     - ignore
@@ -321,2 +328,4 @@ - code
 
+You may use `-S`, `--skipSingleStar` or `{skipSingleStar: true}` to ignore `/* ... */` comments.
+
 ### Running tests
@@ -323,0 +332,0 @@

No alert changes

Improved metrics

Total package byte prevSize

31091

increased by3.11%

Lines of code

525

increased by0.38%

Number of lines in readme file

359

increased by2.57%

No dependency changes