Merge pull request #102 from GentileFulvio/master

fix: Allow `#` and `@` in api param names fix #899
apidoc · Aug 13, 2020 · 393b16f · 393b16f
2 parents 987723d + 7cc84e4
commit 393b16f
Show file tree

Hide file tree

Showing 5 changed files with 299 additions and 2 deletions.
diff --git a/lib/parsers/api_param.js b/lib/parsers/api_param.js
@@ -36,7 +36,7 @@ var regExp = {
     },
     wName: {
         b:               '(\\[?\\s*',                       // 5 optional optional-marker
-        name:                '([a-zA-Z0-9\\$\\:\\.\\/\\\\_-]+',   // 6
+        name:                '([#@a-zA-Z0-9\\$\\:\\.\\/\\\\_-]+',   // 6
             withArray:           '(?:\\[[a-zA-Z0-9\\.\\/\\\\_-]*\\])?)', // https://github.com/apidoc/apidoc-core/pull/4
         oDefaultValue: {                                    // optional defaultValue
             b:               '(?:\\s*=\\s*(?:',             // starting with '=', optional surrounding spaces

diff --git a/lib/parsers/api_private.js b/lib/parsers/api_private.js
@@ -1,4 +1,4 @@
-function parse(content) {
+function parse() {
     return 'private';
 }
 

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -38,6 +38,7 @@
   },
   "devDependencies": {
     "apidoc-example": "^0.2.1",
+    "deep-equal": "^2.0.3",
     "jshint": "^2.10.3",
     "markdown-it": "^10.0.0",
     "mocha": "^6.2.3",