[DependencyInjection] added some usage examples in the PHPDoc

fabpot · fabpot · commit 11acd0e78b46 · 2010-01-15T11:00:29.000+01:00
diff --git a/src/Symfony/Components/DependencyInjection/Loader/Extension/DoctrineExtension.php b/src/Symfony/Components/DependencyInjection/Loader/Extension/DoctrineExtension.php
@@ -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
diff --git a/src/Symfony/Components/DependencyInjection/Loader/Extension/SwiftMailerExtension.php b/src/Symfony/Components/DependencyInjection/Loader/Extension/SwiftMailerExtension.php
@@ -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
diff --git a/src/Symfony/Components/DependencyInjection/Loader/Extension/SymfonyTemplatingExtension.php b/src/Symfony/Components/DependencyInjection/Loader/Extension/SymfonyTemplatingExtension.php
@@ -26,7 +26,15 @@
 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
    *
diff --git a/src/Symfony/Components/DependencyInjection/Loader/Extension/ZendExtension.php b/src/Symfony/Components/DependencyInjection/Loader/Extension/ZendExtension.php
@@ -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 @@ public function loggerLoad($config)
   /**
    * 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

Original file line number	Diff line number	Diff line change
`@@ -27,6 +27,10 @@ class DoctrineExtension extends LoaderExtension`
`27`	`27`	`/**`
`28`	`28`	`* Loads the DBAL configuration.`
`29`	`29`	`*`
	`30`	`+ * Usage example:`
	`31`	`+ *`
	`32`	`+ * <doctrine:dbal dbname="sfweb" username="root" />`
	`33`	`+ *`
`30`	`34`	`* @param array $config A configuration array`
`31`	`35`	`*`
`32`	`36`	`* @return BuilderConfiguration A BuilderConfiguration instance`
Original file line number	Diff line number	Diff line change
`@@ -26,7 +26,15 @@`
`26`	`26`	`class SymfonyTemplatingExtension extends LoaderExtension`
`27`	`27`	`{`
`28`	`28`	`/**`
`29`		`- * Loads the template configuration.`
	`29`	`+ * Loads the templating configuration.`
	`30`	`+ *`
	`31`	`+ * Usage example:`
	`32`	`+ *`
	`33`	`+ * <symfony:templating path="/path/to/templates" cache="/path/to/cache">`
	`34`	`+ * <symfony:loader>symfony.templating.loader.filesystem</symfony:loader>`
	`35`	`+ * <symfony:helper>symfony.templating.helper.javascripts</symfony:helper>`
	`36`	`+ * <symfony:helper>symfony.templating.helper.stylesheets</symfony:helper>`
	`37`	`+ * </symfony:templating>`
`30`	`38`	`*`
`31`	`39`	`* @param array $config A configuration array`
`32`	`40`	`*`
Original file line number	Diff line number	Diff line change
`@@ -27,6 +27,10 @@ class ZendExtension extends LoaderExtension`
`27`	`27`	`/**`
`28`	`28`	`* Loads the logger configuration.`
`29`	`29`	`*`
	`30`	`+ * Usage example:`
	`31`	`+ *`
	`32`	`+ * <zend:logger priority="info" path="/path/to/some.log" />`
	`33`	`+ *`
`30`	`34`	`* @param array $config A configuration array`
`31`	`35`	`*`
`32`	`36`	`* @return BuilderConfiguration A BuilderConfiguration instance`
`@@ -54,6 +58,13 @@ public function loggerLoad($config)`
`54`	`58`	`/**`
`55`	`59`	`* Loads the mail configuration.`
`56`	`60`	`*`
	`61`	`+ * Usage example:`
	`62`	`+ *`
	`63`	`+ * <zend:mail transport="gmail">`
	`64`	`+ * <zend:username>fabien</zend:username>`
	`65`	`+ * <zend:password>xxxxxx</zend:password>`
	`66`	`+ * </zend:mail>`
	`67`	`+ *`
`57`	`68`	`* @param array $config A configuration array`
`58`	`69`	`*`
`59`	`70`	`* @return BuilderConfiguration A BuilderConfiguration instance`