Skip to content

Commit e13f5fb

Browse files
committed
Various docblock cleanup
1 parent ad54b78 commit e13f5fb

17 files changed

+106
-25
lines changed

src/Application.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@
3232
use Symfony\Component\HttpKernel\TerminableInterface;
3333

3434
/**
35-
* An Application
35+
* A Nice Application
3636
*/
3737
class Application implements HttpKernelInterface, ContainerInterface, ExtendableInterface
3838
{

src/DependencyInjection/CacheRoutingDataPass.php

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,10 @@
1313
use Symfony\Component\DependencyInjection\ContainerBuilder;
1414
use Symfony\Component\DependencyInjection\Reference;
1515

16+
/**
17+
* Overrides the default RouteCollector and URL DataGenerator with
18+
* cache-based implementations.
19+
*/
1620
class CacheRoutingDataPass implements CompilerPassInterface
1721
{
1822
/**

src/DependencyInjection/ContainerInitializer/CachedInitializer.php

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,9 @@
1818
use Symfony\Component\DependencyInjection\Dumper\PhpDumper;
1919
use Symfony\Component\DependencyInjection\Extension\ExtensionInterface;
2020

21+
/**
22+
* Wraps a ContainerInitializer, providing a file-based cache for the built container
23+
*/
2124
class CachedInitializer implements ContainerInitializerInterface
2225
{
2326
/**

src/DependencyInjection/ContainerInitializer/DefaultInitializer.php

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,9 @@
2020
use Symfony\Component\HttpKernel\DependencyInjection\MergeExtensionConfigurationPass;
2121
use Symfony\Component\HttpKernel\DependencyInjection\RegisterListenersPass;
2222

23+
/**
24+
* Creates and initializes a Service Container, ready for use by the Application
25+
*/
2326
class DefaultInitializer implements ContainerInitializerInterface
2427
{
2528
/**

src/DependencyInjection/ContainerInitializerInterface.php

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,12 @@
1414
use Symfony\Component\DependencyInjection\ContainerInterface;
1515
use Symfony\Component\DependencyInjection\Extension\ExtensionInterface;
1616

17+
/**
18+
* Defines the contract any ContainerInitializer must follow
19+
*
20+
* A ContainerInitializer is responsible for creating a DependencyInjection Container
21+
* and readying it for use by a Nice Application
22+
*/
1723
interface ContainerInitializerInterface
1824
{
1925
/**

src/DependencyInjection/ExtendableInterface.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
use Symfony\Component\DependencyInjection\Extension\ExtensionInterface;
1313

1414
/**
15-
* Defines the contract any Extendable object should implement
15+
* Defines the contract any Extendable object must implement
1616
*/
1717
interface ExtendableInterface
1818
{

src/Extension/CacheExtension.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
use Symfony\Component\DependencyInjection\Reference;
1515

1616
/**
17-
* Sets up Cache services
17+
* Sets up Doctrine Cache services
1818
*/
1919
class CacheExtension extends Extension
2020
{

src/Extension/RouterExtension.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515
use Symfony\Component\DependencyInjection\Extension\Extension;
1616

1717
/**
18-
* Sets up FastRoute services
18+
* Sets up routing related services
1919
*/
2020
class RouterExtension extends Extension
2121
{

src/Router/NamedDataGenerator/HandlerWrapperGenerator.php

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,13 +12,21 @@
1212
use FastRoute\DataGenerator;
1313
use Nice\Router\NamedDataGeneratorInterface;
1414

15+
/**
16+
* HandlerWrapperGenerator adds extra metadata to routes to support named routes
17+
*/
1518
class HandlerWrapperGenerator implements NamedDataGeneratorInterface
1619
{
1720
/**
1821
* @var \FastRoute\DataGenerator
1922
*/
2023
private $wrappedGenerator;
2124

25+
/**
26+
* Constructor
27+
*
28+
* @param DataGenerator $wrappedGenerator
29+
*/
2230
public function __construct(DataGenerator $wrappedGenerator)
2331
{
2432
$this->wrappedGenerator = $wrappedGenerator;

src/Router/NamedDataGeneratorInterface.php

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,11 @@
1111

1212
use FastRoute\DataGenerator;
1313

14+
/**
15+
* Defines the contract any NamedDataGenerator must implement
16+
*
17+
* A NamedDataGenerator special DataGenerator that can handle named routes
18+
*/
1419
interface NamedDataGeneratorInterface extends DataGenerator
1520
{
1621
/**

0 commit comments

Comments
 (0)