minor #13240 Escape annotations in comments (cmfcmf)

fabpot · fabpot · commit bd8ff0450699 · 2015-01-04T19:18:18.000+01:00
This PR was merged into the 2.3 branch. Discussion ---------- Escape annotations in comments | Q | A | ------------- | --- | Fixed tickets | --- | Referenced tickets | #13089 | License | MIT Commits ------- 0cb17f3 Escape annotations in comments, refs #13089.
diff --git a/src/Symfony/Component/HttpKernel/Kernel.php b/src/Symfony/Component/HttpKernel/Kernel.php
@@ -242,35 +242,9 @@ public function getBundle($name, $first = true)
     }
 
     /**
-     * Returns the file path for a given resource.
+     * {@inheritDoc}
      *
-     * A Resource can be a file or a directory.
-     *
-     * The resource name must follow the following pattern:
-     *
-     *     @<BundleName>/path/to/a/file.something
-     *
-     * where BundleName is the name of the bundle
-     * and the remaining part is the relative path in the bundle.
-     *
-     * If $dir is passed, and the first segment of the path is "Resources",
-     * this method will look for a file named:
-     *
-     *     $dir/<BundleName>/path/without/Resources
-     *
-     * before looking in the bundle resource folder.
-     *
-     * @param string $name  A resource name to locate
-     * @param string $dir   A directory where to look for the resource first
-     * @param bool   $first Whether to return the first path or paths for all matching bundles
-     *
-     * @return string|array The absolute path of the resource or an array if $first is false
-     *
-     * @throws \InvalidArgumentException if the file cannot be found or the name is not valid
-     * @throws \RuntimeException         if the name contains invalid/unsafe
-     * @throws \RuntimeException         if a custom resource is hidden by a resource in a derived bundle
-     *
-     * @api
+     * @throws \RuntimeException if a custom resource is hidden by a resource in a derived bundle
      */
     public function locateResource($name, $dir = null, $first = true)
     {
diff --git a/src/Symfony/Component/HttpKernel/KernelInterface.php b/src/Symfony/Component/HttpKernel/KernelInterface.php
@@ -101,15 +101,17 @@ public function getBundle($name, $first = true);
      *
      * The resource name must follow the following pattern:
      *
-     *     @BundleName/path/to/a/file.something
+     *     "@BundleName/path/to/a/file.something"
      *
      * where BundleName is the name of the bundle
      * and the remaining part is the relative path in the bundle.
      *
-     * If $dir is passed, and the first segment of the path is Resources,
+     * If $dir is passed, and the first segment of the path is "Resources",
      * this method will look for a file named:
      *
-     *     $dir/BundleName/path/without/Resources
+     *     $dir/<BundleName>/path/without/Resources
+     *
+     * before looking in the bundle resource folder.
      *
      * @param string $name  A resource name to locate
      * @param string $dir   A directory where to look for the resource first

Original file line number	Diff line number	Diff line change
`@@ -101,15 +101,17 @@ public function getBundle($name, $first = true);`
`101`	`101`	`*`
`102`	`102`	`* The resource name must follow the following pattern:`
`103`	`103`	`*`
`104`		`- * @BundleName/path/to/a/file.something`
	`104`	`+ * "@BundleName/path/to/a/file.something"`
`105`	`105`	`*`
`106`	`106`	`* where BundleName is the name of the bundle`
`107`	`107`	`* and the remaining part is the relative path in the bundle.`
`108`	`108`	`*`
`109`		`- * If $dir is passed, and the first segment of the path is Resources,`
	`109`	`+ * If $dir is passed, and the first segment of the path is "Resources",`
`110`	`110`	`* this method will look for a file named:`
`111`	`111`	`*`
`112`		`- * $dir/BundleName/path/without/Resources`
	`112`	`+ * $dir/<BundleName>/path/without/Resources`
	`113`	`+ *`
	`114`	`+ * before looking in the bundle resource folder.`
`113`	`115`	`*`
`114`	`116`	`* @param string $name A resource name to locate`
`115`	`117`	`* @param string $dir A directory where to look for the resource first`