Skip to content

Commit 68a55ae

Browse files
Merge pull request #78 from SassDoc/default-brackets
Use brackets for default values instead of parens
2 parents 9469416 + 0f6b4ea commit 68a55ae

File tree

2 files changed

+6
-6
lines changed

2 files changed

+6
-6
lines changed

annotations/index.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -360,15 +360,15 @@ Describes the documented item.
360360
* @param {type} $name
361361
* @param {type | othertype} $name
362362
* @param {type} $name - description
363-
* @param {type} $name (default value) - description
363+
* @param {type} $name [default value] - description
364364
*/
365365
{% endhighlight %}
366366

367367
{% highlight scss %}
368368
/// @param {type} $name
369369
/// @param {type | othertype} $name
370370
/// @param {type} $name - description
371-
/// @param {type} $name (default value) - description
371+
/// @param {type} $name [default value] - description
372372
{% endhighlight %}
373373

374374
## @property
@@ -387,12 +387,12 @@ Describes the documented item.
387387

388388
{% highlight scss %}
389389
/**
390-
* @prop {Type} base.default (default) - description
390+
* @prop {Type} base.default [default] - description
391391
*/
392392
{% endhighlight %}
393393

394394
{% highlight scss %}
395-
/// @prop {Type} base.default (default) - description
395+
/// @prop {Type} base.default [default] - description
396396
{% endhighlight %}
397397

398398
## @require

data-interface/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -254,7 +254,7 @@ An item will look like this:
254254

255255
{% highlight scss %}
256256
/**
257-
* @param {type} $name (default value) - description
257+
* @param {type} $name [default value] - description
258258
*/
259259
{% endhighlight %}
260260

@@ -276,7 +276,7 @@ An item will look like this:
276276

277277
{% highlight scss %}
278278
/**
279-
* @prop {Function} base.default (default) - description
279+
* @prop {Function} base.default [default] - description
280280
*/
281281
{% endhighlight %}
282282

0 commit comments

Comments
 (0)