From 13d8f4f3e1ef0cb70e4a3bcc5d252da41cc8b9ed Mon Sep 17 00:00:00 2001 From: Jeremiasz Major Date: Sun, 29 Nov 2020 03:03:09 +0100 Subject: [PATCH] Fix broken links in documentation (#4730) * Fix links in documentation * Fix more links --- docs/annotating_code/supported_annotations.md | 20 +++++++++---------- .../type_syntax/array_types.md | 2 +- docs/annotating_code/typing_in_psalm.md | 2 +- 3 files changed, 12 insertions(+), 12 deletions(-) diff --git a/docs/annotating_code/supported_annotations.md b/docs/annotating_code/supported_annotations.md index 08ef20dd0..12df76100 100644 --- a/docs/annotating_code/supported_annotations.md +++ b/docs/annotating_code/supported_annotations.md @@ -6,23 +6,23 @@ Psalm supports a wide range of docblock annotations. Psalm uses the following PHPDoc tags to understand your code: -- [`@var`](https://docs.phpdoc.org/latest/references/phpdoc/tags/var.html) +- [`@var`](https://docs.phpdoc.org/latest/guide/references/phpdoc/tags/var.html) Used for specifying the types of properties and variables@ -- [`@return`](https://docs.phpdoc.org/latest/references/phpdoc/tags/return.html) +- [`@return`](https://docs.phpdoc.org/latest/guide/references/phpdoc/tags/return.html) Used for specifying the return types of functions, methods and closures -- [`@param`](https://docs.phpdoc.org/latest/references/phpdoc/tags/param.html) +- [`@param`](https://docs.phpdoc.org/latest/guide/references/phpdoc/tags/param.html) Used for specifying types of parameters passed to functions, methods and closures -- [`@property`](https://docs.phpdoc.org/latest/references/phpdoc/tags/property.html) +- [`@property`](https://docs.phpdoc.org/latest/guide/references/phpdoc/tags/property.html) Used to specify what properties can be accessed on an object that uses `__get` and `__set` -- [`@property-read`](https://docs.phpdoc.org/latest/references/phpdoc/tags/property-read.html) +- [`@property-read`](https://docs.phpdoc.org/latest/guide/references/phpdoc/tags/property-read.html) Used to specify what properties can be read on object that uses `__get` -- [`@property-write`](https://docs.phpdoc.org/latest/references/phpdoc/tags/property-write.html) +- [`@property-write`](https://docs.phpdoc.org/latest/guide/references/phpdoc/tags/property-write.html) Used to specify what properties can be written on object that uses `__set` -- [`@method`](https://docs.phpdoc.org/latest/references/phpdoc/tags/method.html) +- [`@method`](https://docs.phpdoc.org/latest/guide/references/phpdoc/tags/method.html) Used to specify which magic methods are available on object that uses `__call`. -- [`@deprecated`](https://docs.phpdoc.org/latest/references/phpdoc/tags/deprecated.html) +- [`@deprecated`](https://docs.phpdoc.org/latest/guide/references/phpdoc/tags/deprecated.html) Used to mark functions, methods, classes and interfaces as being deprecated -- [`@internal`](https://docs.phpdoc.org/latest/references/phpdoc/tags/internal.html) +- [`@internal`](https://docs.phpdoc.org/latest/guide/references/phpdoc/tags/internal.html) used to mark classes, functions and properties that are internal to an application or library. ### Off-label usage of the `@var` tag @@ -509,6 +509,6 @@ Behaves the same way as `@psalm-require-extends`, but for interfaces. ## Type Syntax -Psalm supports PHPDoc’s [type syntax](https://docs.phpdoc.org/latest/guides/types.html), and also the [proposed PHPDoc PSR type syntax](https://github.com/php-fig/fig-standards/blob/master/proposed/phpdoc.md#appendix-a-types). +Psalm supports PHPDoc’s [type syntax](https://docs.phpdoc.org/latest/guide/guides/types.html), and also the [proposed PHPDoc PSR type syntax](https://github.com/php-fig/fig-standards/blob/master/proposed/phpdoc.md#appendix-a-types). A detailed write-up is found in [Typing in Psalm](typing_in_psalm.md) diff --git a/docs/annotating_code/type_syntax/array_types.md b/docs/annotating_code/type_syntax/array_types.md index 83f30a75a..44045fe67 100644 --- a/docs/annotating_code/type_syntax/array_types.md +++ b/docs/annotating_code/type_syntax/array_types.md @@ -36,7 +36,7 @@ You can also specify that an array is non-empty with the special type `non-empty ### PHPDoc syntax -PHPDoc [allows you to specify](https://phpdoc.org/docs/latest/references/phpdoc/types.html#arrays) the type of values a generic array holds with the annotation: +PHPDoc [allows you to specify](https://docs.phpdoc.org/latest/guide/references/phpdoc/types.html#arrays) the type of values a generic array holds with the annotation: ```php /** @return ValueType[] */ ``` diff --git a/docs/annotating_code/typing_in_psalm.md b/docs/annotating_code/typing_in_psalm.md index b2c8ee0ae..85e1211cc 100644 --- a/docs/annotating_code/typing_in_psalm.md +++ b/docs/annotating_code/typing_in_psalm.md @@ -10,7 +10,7 @@ Psalm allows you to express a lot of complicated type information in docblocks. All docblock types are either [atomic types](type_syntax/atomic_types.md), [union types](type_syntax/union_types.md) or [intersection types](type_syntax/intersection_types.md). -Additionally Psalm supports PHPDoc’s [type syntax](https://docs.phpdoc.org/guides/types.html), and also the [proposed PHPDoc PSR type syntax](https://github.com/php-fig/fig-standards/blob/master/proposed/phpdoc.md#appendix-a-types). +Additionally Psalm supports PHPDoc’s [type syntax](https://docs.phpdoc.org/latest/guide/guides/types.html), and also the [proposed PHPDoc PSR type syntax](https://github.com/php-fig/fig-standards/blob/master/proposed/phpdoc.md#appendix-a-types). ## Property declaration types vs Assignment typehints