Skip to content

Commit b954fbc

Browse files
committed
minor symfony#28297 [HttpKernel] Fix inheritdocs (ro0NL)
This PR was squashed before being merged into the 2.8 branch (closes symfony#28297). Discussion ---------- [HttpKernel] Fix inheritdocs | Q | A | ------------- | --- | Branch? | 2.8 | Bug fix? | yes | New feature? | no | BC breaks? | no <!-- see https://symfony.com/bc --> | Deprecations? | no | Tests pass? | yes <!-- please add some, will be required by reviewers --> | Fixed tickets | #... <!-- #-prefixed issue number(s), if any --> | License | MIT | Doc PR | symfony/symfony-docs#... <!-- required for new features --> fixed some obvious inheritdocs for Kernel & Bundle class. Nevertheless there's a lot of inconsistency in general, and this probably deserves a CS fixer long term. Commits ------- b04ef43 [HttpKernel] Fix inheritdocs
2 parents 411e0c5 + b04ef43 commit b954fbc

File tree

3 files changed

+13
-24
lines changed

3 files changed

+13
-24
lines changed

src/Symfony/Component/DependencyInjection/ContainerAwareInterface.php

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,5 +18,8 @@
1818
*/
1919
interface ContainerAwareInterface
2020
{
21+
/**
22+
* Sets the container.
23+
*/
2124
public function setContainer(ContainerInterface $container = null);
2225
}

src/Symfony/Component/HttpKernel/Bundle/Bundle.php

Lines changed: 9 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -35,23 +35,21 @@ abstract class Bundle implements BundleInterface
3535
protected $path;
3636

3737
/**
38-
* Boots the Bundle.
38+
* {@inheritdoc}
3939
*/
4040
public function boot()
4141
{
4242
}
4343

4444
/**
45-
* Shutdowns the Bundle.
45+
* {@inheritdoc}
4646
*/
4747
public function shutdown()
4848
{
4949
}
5050

5151
/**
52-
* Builds the bundle.
53-
*
54-
* It is only ever called once when the cache is empty.
52+
* {@inheritdoc}
5553
*
5654
* This method can be overridden to register compilation passes,
5755
* other extensions, ...
@@ -61,19 +59,15 @@ public function build(ContainerBuilder $container)
6159
}
6260

6361
/**
64-
* Sets the container.
65-
*
66-
* @param ContainerInterface|null $container A ContainerInterface instance or null
62+
* {@inheritdoc}
6763
*/
6864
public function setContainer(ContainerInterface $container = null)
6965
{
7066
$this->container = $container;
7167
}
7268

7369
/**
74-
* Returns the bundle's container extension.
75-
*
76-
* @return ExtensionInterface|null The container extension
70+
* {@inheritdoc}
7771
*
7872
* @throws \LogicException
7973
*/
@@ -110,9 +104,7 @@ public function getContainerExtension()
110104
}
111105

112106
/**
113-
* Gets the Bundle namespace.
114-
*
115-
* @return string The Bundle namespace
107+
* {@inheritdoc}
116108
*/
117109
public function getNamespace()
118110
{
@@ -122,9 +114,7 @@ public function getNamespace()
122114
}
123115

124116
/**
125-
* Gets the Bundle directory path.
126-
*
127-
* @return string The Bundle absolute path
117+
* {@inheritdoc}
128118
*/
129119
public function getPath()
130120
{
@@ -137,18 +127,14 @@ public function getPath()
137127
}
138128

139129
/**
140-
* Returns the bundle parent name.
141-
*
142-
* @return string|null The Bundle parent name it overrides or null if no parent
130+
* {@inheritdoc}
143131
*/
144132
public function getParent()
145133
{
146134
}
147135

148136
/**
149-
* Returns the bundle name (the class short name).
150-
*
151-
* @return string The Bundle name
137+
* {@inheritdoc}
152138
*/
153139
final public function getName()
154140
{

src/Symfony/Component/HttpKernel/Kernel.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -112,7 +112,7 @@ public function __clone()
112112
}
113113

114114
/**
115-
* Boots the current kernel.
115+
* {@inheritdoc}
116116
*/
117117
public function boot()
118118
{

0 commit comments

Comments
 (0)