Skip to content

Use brackets for default values instead of parens #78

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
valeriangalliat merged 1 commit into from
Jan 5, 2015
Merged

Use brackets for default values instead of parens #78

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions annotations/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -360,15 +360,15 @@ Describes the documented item.
* @param {type} $name
* @param {type | othertype} $name
* @param {type} $name - description
* @param {type} $name (default value) - description
* @param {type} $name [default value] - description
*/
{% endhighlight %}

{% highlight scss %}
/// @param {type} $name
/// @param {type | othertype} $name
/// @param {type} $name - description
/// @param {type} $name (default value) - description
/// @param {type} $name [default value] - description
{% endhighlight %}

## @property
Expand All @@ -387,12 +387,12 @@ Describes the documented item.

{% highlight scss %}
/**
* @prop {Type} base.default (default) - description
* @prop {Type} base.default [default] - description
*/
{% endhighlight %}

{% highlight scss %}
/// @prop {Type} base.default (default) - description
/// @prop {Type} base.default [default] - description
{% endhighlight %}

## @require
Expand Down
4 changes: 2 additions & 2 deletions data-interface/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -254,7 +254,7 @@ An item will look like this:

{% highlight scss %}
/**
* @param {type} $name (default value) - description
* @param {type} $name [default value] - description
*/
{% endhighlight %}

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

{% highlight scss %}
/**
* @prop {Function} base.default (default) - description
* @prop {Function} base.default [default] - description
*/
{% endhighlight %}

Expand Down