Skip to content

Commit f86fd4d

Browse files
Use brackets for default values instead of parens
* Closes #303 * Documentation: SassDoc/sassdoc.github.io#78
1 parent 2b4ca40 commit f86fd4d

File tree

6 files changed

+15
-15
lines changed

6 files changed

+15
-15
lines changed

src/annotation/annotations/parameter.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
let typeRegEx = /^\s*(?:\{(.*)\})?\s*(?:\$?([^\s]+))?\s*(?:\((.*)\))?\s*(?:-?\s*([\s\S]*))?/;
1+
let typeRegEx = /^\s*(?:\{(.*)\})?\s*(?:\$?([^\s]+))?\s*(?:\[([^\]]*)\])?\s*(?:-?\s*([\s\S]*))?/;
22

33
export default function parameter() {
44
return {

src/annotation/annotations/property.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
let reqRegEx = /\s*(?:\{(.*)\})?\s*(?:(\$?[^\s]+))?\s*(?:\(([^\)]*)\))?\s*(?:-?\s*([\s\S]*))\s*$/;
1+
let reqRegEx = /\s*(?:\{(.*)\})?\s*(?:(\$?[^\s]+))?\s*(?:\[([^\]]*)\])?\s*(?:-?\s*([\s\S]*))\s*$/;
22

33
export default function property() {
44
return {

src/annotation/annotations/require.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
let utils = require('../../utils');
22
let uniq = require('lodash').uniq;
33

4-
let reqRegEx = /^\s*(?:\{(.*)\})?\s*(?:(\$?[^\s]+))?\s*(?:\((.*)\))?\s*(?:-?\s*([^<$]*))?\s*(?:<?\s*(.*)\s*>)?$/;
4+
let reqRegEx = /^\s*(?:\{(.*)\})?\s*(?:(\$?[^\s]+))?\s*(?:\[([^\]]*)\])?\s*(?:-?\s*([^<$]*))?\s*(?:<?\s*(.*)\s*>)?$/;
55

66
export default function (config) {
77
return {

test/annotations/parameter.test.js

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,8 @@ describe('#parameter', function () {
88
var param = (new (require('../../dist/annotation').default)()).list.parameter;
99

1010
it('should return an object', function () {
11-
assert.deepEqual(param.parse('{type} $hyphenated-name (default) - description'), { type: 'type', name: 'hyphenated-name', default: 'default', description: 'description' });
12-
assert.deepEqual(param.parse('{type} $name (()) - description'), { type: 'type', name: 'name', default: '()', description: 'description' });
11+
assert.deepEqual(param.parse('{type} $hyphenated-name [default] - description'), { type: 'type', name: 'hyphenated-name', default: 'default', description: 'description' });
12+
assert.deepEqual(param.parse('{type} $name [default] - description [with brackets]'), { type: 'type', name: 'name', default: 'default', description: 'description [with brackets]' });
1313
assert.deepEqual(param.parse('{List} $list - list to check'), { type: 'List', name: 'list', description: 'list to check' });
1414
});
1515

@@ -19,11 +19,11 @@ describe('#parameter', function () {
1919
});
2020

2121
it('should work for multiline description', function () {
22-
assert.deepEqual(param.parse('{type} $hyphenated-name (default) - description\nmore\nthan\none\nline'), { type: 'type', name: 'hyphenated-name', default: 'default', description: 'description\nmore\nthan\none\nline' });
22+
assert.deepEqual(param.parse('{type} $hyphenated-name [default] - description\nmore\nthan\none\nline'), { type: 'type', name: 'hyphenated-name', default: 'default', description: 'description\nmore\nthan\none\nline' });
2323
});
2424

2525
it('should work without the $', function () {
26-
assert.deepEqual(param.parse('{type} hyphenated-name (default) - description\nmore\nthan\none\nline'), { type: 'type', name: 'hyphenated-name', default: 'default', description: 'description\nmore\nthan\none\nline' });
26+
assert.deepEqual(param.parse('{type} hyphenated-name [default] - description\nmore\nthan\none\nline'), { type: 'type', name: 'hyphenated-name', default: 'default', description: 'description\nmore\nthan\none\nline' });
2727
});
2828

2929
});

test/annotations/property.test.js

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -24,23 +24,23 @@ describe('#property', function () {
2424
description: 'description'
2525
});
2626

27-
assert.deepEqual(prop.parse('{Function} base.default (default) - description'), {
27+
assert.deepEqual(prop.parse('{Function} base.default [default] - description'), {
2828
type: 'Function',
2929
name: 'base.default',
3030
default: 'default',
3131
description: 'description'
3232
});
3333

34-
assert.deepEqual(prop.parse('{Function} base.default (default) - description (with parens)'), {
34+
assert.deepEqual(prop.parse('{Function} base.default [default] - description [with brackets]'), {
3535
type: 'Function',
3636
name: 'base.default',
3737
default: 'default',
38-
description: 'description (with parens)'
38+
description: 'description [with brackets]'
3939
});
4040
});
4141

4242
it('should work for multiline description', function(){
43-
assert.deepEqual(prop.parse('{Function} base.default (default) - description\nmore\nthan\none\nline'), {
43+
assert.deepEqual(prop.parse('{Function} base.default [default] - description\nmore\nthan\none\nline'), {
4444
type: 'Function',
4545
name: 'base.default',
4646
default: 'default',

test/data/test.scss

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@
6767
* - `@throw`
6868
*
6969
* @param {*} $arg - Whatever
70-
* @param {List} $extra-arguments (()) - Extra arguments
70+
* @param {List} $extra-arguments [()] - Extra arguments
7171
*
7272
* @return {*} Anything
7373
*
@@ -85,7 +85,7 @@
8585
*
8686
* @content Content is parsed and whatever.
8787
*
88-
* @param {Number} $number (42) - Number
88+
* @param {Number} $number [42] - Number
8989
* @param {Arglist} $extra-arguments - Extra arguments
9090
*
9191
* @output Nothing
@@ -100,8 +100,8 @@
100100
* - `@prop`
101101
* - `@type`
102102
*
103-
* @prop {String} base.first-key ("default") - Description
104-
* @prop {String} base.second-key (42) - Description
103+
* @prop {String} base.first-key ["default"] - Description
104+
* @prop {String} base.second-key [42] - Description
105105
*
106106
* @type {*}
107107
*/

0 commit comments

Comments
 (0)