For interfaces and abstract methods it is generally a good practice to add a @return annotation even if it is just @return void or @return null, so that implementors know what to do in the overridden method.
For interface and abstract methods, it is impossible to infer the return type
from the immediate code. In these cases, it is generally advisible to explicitly
annotate these methods with a @return doc comment to communicate to implementors
of these methods what they are expected to return.
Loading history...
23
24
/**
25
* assign routes to router
26
*
27
* @param RoutesInterface $routes
28
* @return RouterInterface
29
*/
30
public function setRoutes(RoutesInterface $routes): RouterInterface;
31
32
/**
33
* compiles routes
34
*
35
* @return array
36
*/
37
public function compile(): array;
38
39
/**
40
* return slugs params
41
*
42
* @return array
43
*/
44
public function getParams(): array;
45
46
/**
47
* set params from slugs
48
*
49
* @param RouteInterface $route
50
* @param array $matches
51
* @return RouterInterface
52
*/
53
public function setParams(RouteInterface $route, array $matches): RouterInterface;
pierre-fromager /
nymfonya-http-foundation
For interface and abstract methods, it is impossible to infer the return type from the immediate code. In these cases, it is generally advisible to explicitly annotate these methods with a
@returndoc comment to communicate to implementors of these methods what they are expected to return.