Scramble 0.11.0 is here! Laravel Data support, schema enforcement and more
Learn more
Annotations reference
On this page
Scramble PRO
Comprehensive API documentation generation for Spatie’s Laravel Data and Laravel Query Builder.
On this page all available annotations, attributes are collected.
Attributes
| Attribute | Applies to | Description |
|---|---|---|
ExcludeRouteFromDocs | Controllers’ methods | Excludes a route from docs. |
ExcludeAllRoutesFromDocs | Controllers | Excludes all controller’s routes from docs. |
Note: All attributes are classes located in Dedoc\Scramble\Attributes namespace. So the attribute ExcludeRouteFromDocs in the following table should be imported as Dedoc\Scramble\Attributes\ExcludeRouteFromDocs FQN.
Annotations
Annotations are PHPDoc annotations that should be added to whatever is stated in “Applies to” column.
| Annotation | Applies to | Description |
|---|---|---|
@deprecated | Classes, methods | Marks routes of a class as deprecated. |
@not-deprecated | Methods | Marks a route of a deprecated controller as not deprecated. |