Skip to content

Commit 9469416

Browse files
committed
Added allowed types for require and see annotations
1 parent 2c4b709 commit 9469416

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

annotations/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -405,7 +405,7 @@ Describes the documented item.
405405
| Aliases | `@requires` |
406406
| Autofilled | true |
407407
| Allowed on | functions, mixins, placeholders, variables |
408-
| Extra notes | Type is optional; default type is `function`.<br>Description is optional. Hyphen before description is optional.<br>Description is parsed as Markdown.*<br>Link is optional.<br>Item name can contain `::`, `:`, `.` and/or `/` when item is from an external resource.<br>Link is used as a link if present, else it tries to link to an inner item, else it doesn't have a link.<br>If `{type}` is `variable`, then the `$` sign before the variable name is optional. Alongside if there is a `$` sign before the item name, then the `{variable}` type is optional.<br>If `{type}` is `placeholder`, then the `%` sign before the placeholder name is optional. Alongside if there is a `%` sign before the item name, then the `{placeholder}` type is optional.<br>The other item will automatically have a key named `usedBy` containing the name of function requiring it. |
408+
| Extra notes | Type is optional; default type is `function`. Can be either `function`, `mixin`, `variable` or `placeholder`.<br>If `{type}` is `variable`, then the `$` sign before the variable name is optional. Alongside if there is a `$` sign before the item name, then the `{variable}` type is optional.<br>If `{type}` is `placeholder`, then the `%` sign before the placeholder name is optional. Alongside if there is a `%` sign before the item name, then the `{placeholder}` type is optional.<br>Description is optional. Hyphen before description is optional.<br>Description is parsed as Markdown.*<br>Link is optional.<br>Item name can contain `::`, `:`, `.` and/or `/` when item is from an external resource.<br>Link is used as a link if present, else it tries to link to an inner item, else it doesn't have a link.<br>The other item will automatically have a key named `usedBy` containing the name of function requiring it. |
409409

410410
### Example
411411

@@ -475,7 +475,7 @@ Describes the documented item.
475475
| Aliases | &mdash; |
476476
| Autofilled | false |
477477
| Allowed on | functions, mixins, placeholders, variables |
478-
| Extra notes | Type is optional; default type is `function`.<br>If `{type}` is `variable`, then the `$` sign before the variable name is optional. Alongside if there is a `$` sign before the item name, then the `{variable}` type is optional.<br>If `{type}` is `placeholder`, then the `%` sign before the placeholder name is optional. Alongside if there is a `%` sign before the item name, then the `{placeholder}` type is optional. |
478+
| Extra notes | Type is optional; default type is `function`. Can be either `function`, `mixin`, `variable` or `placeholder`.<br>If `{type}` is `variable`, then the `$` sign before the variable name is optional. Alongside if there is a `$` sign before the item name, then the `{variable}` type is optional.<br>If `{type}` is `placeholder`, then the `%` sign before the placeholder name is optional. Alongside if there is a `%` sign before the item name, then the `{placeholder}` type is optional. |
479479

480480
### Example
481481

0 commit comments

Comments
 (0)