[DependencyInjection] added some usage examples in the PHPDoc

This commit is contained in:
Fabien Potencier 2010-01-15 11:00:29 +01:00
parent 008d9da88f
commit 11acd0e78b
4 changed files with 32 additions and 1 deletions

View File

@ -27,6 +27,10 @@ class DoctrineExtension extends LoaderExtension
/**
* Loads the DBAL configuration.
*
* Usage example:
*
* <doctrine:dbal dbname="sfweb" username="root" />
*
* @param array $config A configuration array
*
* @return BuilderConfiguration A BuilderConfiguration instance

View File

@ -27,6 +27,14 @@ class SwiftMailerExtension extends LoaderExtension
/**
* Loads the Swift Mailer configuration.
*
* Usage example:
*
* <swift:mailer transport="gmail" delivery_strategy="spool">
* <swift:username>fabien</swift:username>
* <swift:password>xxxxx</swift:password>
* <swift:spool path="/path/to/spool/" />
* </swift:mailer>
*
* @param array $config A configuration array
*
* @return BuilderConfiguration A BuilderConfiguration instance

View File

@ -26,7 +26,15 @@ use Symfony\Components\DependencyInjection\Reference;
class SymfonyTemplatingExtension extends LoaderExtension
{
/**
* Loads the template configuration.
* Loads the templating configuration.
*
* Usage example:
*
* <symfony:templating path="/path/to/templates" cache="/path/to/cache">
* <symfony:loader>symfony.templating.loader.filesystem</symfony:loader>
* <symfony:helper>symfony.templating.helper.javascripts</symfony:helper>
* <symfony:helper>symfony.templating.helper.stylesheets</symfony:helper>
* </symfony:templating>
*
* @param array $config A configuration array
*

View File

@ -27,6 +27,10 @@ class ZendExtension extends LoaderExtension
/**
* Loads the logger configuration.
*
* Usage example:
*
* <zend:logger priority="info" path="/path/to/some.log" />
*
* @param array $config A configuration array
*
* @return BuilderConfiguration A BuilderConfiguration instance
@ -54,6 +58,13 @@ class ZendExtension extends LoaderExtension
/**
* Loads the mail configuration.
*
* Usage example:
*
* <zend:mail transport="gmail">
* <zend:username>fabien</zend:username>
* <zend:password>xxxxxx</zend:password>
* </zend:mail>
*
* @param array $config A configuration array
*
* @return BuilderConfiguration A BuilderConfiguration instance