Skip to content

Commit

Permalink
Fix phpdoc
Browse files Browse the repository at this point in the history
  • Loading branch information
vjik committed Sep 11, 2023
1 parent 1658c5c commit 1d93130
Showing 1 changed file with 5 additions and 8 deletions.
13 changes: 5 additions & 8 deletions src/Aliases.php
Original file line number Diff line number Diff line change
Expand Up @@ -47,17 +47,14 @@ public function __construct(array $config = [])
* Note that this method does not check if the given path exists or not. All it does is
* to associate the alias with the path.
*
* Any trailing '/' and '\' characters in the given path will be trimmed.
*
* @param string $alias the alias name (e.g. "@vendor"). It must start with a '@' character.
* @param string $alias The alias name (e.g. "@vendor"). It must start with a '@' character.
* It may contain the forward slash '/' which serves as boundary character when performing
* alias translation by {@see get()}.
* @param string $path the path corresponding to the alias.
* Trailing '/' and '\' characters will be trimmed. This can be
* @param string $path The path corresponding to the alias. This can be:
*
* - a directory or a file path (e.g. `/tmp`, `/tmp/main.txt`)
* - a URL (e.g. `http://www.yiiframework.com`)
* - a path alias (e.g. `@vendor/yiisoft`). It will be resolved on {@see get()} call.
* - a directory or a file path (e.g. `/tmp`, `/tmp/main.txt`);
* - a URL (e.g. `http://www.yiiframework.com`);
* - a path alias (e.g. `@vendor/yiisoft`), it will be resolved on {@see get()} call.
*
* @see get()
*/
Expand Down

0 comments on commit 1d93130

Please sign in to comment.