Merge pull request #62 from Znarkus/multi_param_type

Support multiple param types with |
apidoc · Oct 16, 2019 · 3776ebd · 3776ebd
2 parents 23e1586 + f06fd32
commit 3776ebd
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 1 deletion.
diff --git a/lib/parsers/api_param.js b/lib/parsers/api_param.js
@@ -21,7 +21,7 @@ var regExp = {
     },
     oType: {                                                // optional type: {string}
         b:               '\\s*(?:\\{\\s*',                  // starting with '{', optional surrounding spaces
-        type:                '([a-zA-Z0-9\(\)#:\\.\\/\\\\\\[\\]_-]+)', // 2
+        type:                '([a-zA-Z0-9\(\)#:\\.\\/\\\\\\[\\]_\|-]+)', // 2
         oSize: {                                            // optional size within type: {string{1..4}}
             b:               '\\s*(?:\\{\\s*',              // starting with '{', optional surrounding spaces
             size:                '(.+?)',                   // 3

diff --git a/test/parser_api_param_test.js b/test/parser_api_param_test.js
@@ -42,6 +42,20 @@ describe('Parser: apiParam', function() {
                 description: 'The users name.'
             }
         },
+        {
+            title: 'Type, Fieldname, Description',
+            content: '{String|String[]} name The users name.',
+            expected: {
+                group: 'Parameter',
+                type: 'String|String[]',
+                size: undefined,
+                allowedValues: undefined,
+                optional: false,
+                field: 'name',
+                defaultValue: undefined,
+                description: 'The users name.'
+            }
+        },
         {
             title: '$Simple fieldname only',
             content: '$simple',