Improve comments in ProfilerController

raziel057 · fabpot · commit 00d282324c7c · 2012-10-28T07:05:50.000+01:00
diff --git a/src/Symfony/Bundle/WebProfilerBundle/Controller/ProfilerController.php b/src/Symfony/Bundle/WebProfilerBundle/Controller/ProfilerController.php
@@ -34,6 +34,15 @@ class ProfilerController
     private $templates;
     private $toolbarPosition;
 
+    /**
+     * Constructor.
+     *
+     * @param UrlGeneratorInterface $generator       The Url Generator
+     * @param Profiler              $profiler        The profiler
+     * @param \Twig_Environment     $twig            The twig environment
+     * @param array                 $templates       The templates
+     * @param string                $toolbarPosition The toolbar position (top, bottom, normal, or null -- use the configuration)
+     */
     public function __construct(UrlGeneratorInterface $generator, Profiler $profiler, \Twig_Environment $twig, array $templates, $toolbarPosition = 'normal')
     {
         $this->generator = $generator;
@@ -46,7 +55,7 @@ public function __construct(UrlGeneratorInterface $generator, Profiler $profiler
     /**
      * Renders a profiler panel for the given token.
      *
-     * @param Request $request The HTTP request
+     * @param Request $request The current HTTP request
      * @param string  $token   The profiler token
      *
      * @return Response A Response instance
@@ -115,7 +124,7 @@ public function purgeAction()
     /**
      * Imports token data.
      *
-     * @param Request $request
+     * @param Request $request The current HTTP Request
      *
      * @return Response A Response instance
      */
@@ -139,7 +148,7 @@ public function importAction(Request $request)
     /**
      * Displays information page.
      *
-     * @param string $about
+     * @param string $about The about message
      *
      * @return Response A Response instance
      */
@@ -155,7 +164,7 @@ public function infoAction($about)
     /**
      * Renders the Web Debug Toolbar.
      *
-     * @param Request $request  The current Request
+     * @param Request $request  The current HTTP Request
      * @param string  $token    The profiler token
      * @param string  $position The toolbar position (top, bottom, normal, or null -- use the configuration)
      *
@@ -203,7 +212,7 @@ public function toolbarAction(Request $request, $token, $position = null)
     /**
      * Renders the profiler search bar.
      *
-     * @param Request $request  The current Request
+     * @param Request $request The current HTTP Request
      *
      * @return Response A Response instance
      */
@@ -237,8 +246,8 @@ public function searchBarAction(Request $request)
     /**
      * Search results.
      *
-     * @param Request $request  The current Request
-     * @param string  $token    The token
+     * @param Request $request The current HTTP Request
+     * @param string  $token   The token
      *
      * @return Response A Response instance
      */
@@ -268,7 +277,7 @@ public function searchResultsAction(Request $request, $token)
     /**
      * Narrow the search bar.
      *
-     * @param Request $request  The current Request
+     * @param Request $request The current HTTP Request
      *
      * @return Response A Response instance
      */
@@ -321,6 +330,11 @@ public function phpinfoAction()
         return new Response($phpinfo);
     }
 
+    /**
+     * Gets the Template Manager.
+     *
+     * @return TemplateManager The Template Manager
+     */
     protected function getTemplateManager()
     {
         if (null === $this->templateManager) {

Original file line number	Diff line number	Diff line change
`@@ -34,6 +34,15 @@ class ProfilerController`
`34`	`34`	`private $templates;`
`35`	`35`	`private $toolbarPosition;`
`36`	`36`
	`37`	`+ /**`
	`38`	`+ * Constructor.`
	`39`	`+ *`
	`40`	`+ * @param UrlGeneratorInterface $generator The Url Generator`
	`41`	`+ * @param Profiler $profiler The profiler`
	`42`	`+ * @param \Twig_Environment $twig The twig environment`
	`43`	`+ * @param array $templates The templates`
	`44`	`+ * @param string $toolbarPosition The toolbar position (top, bottom, normal, or null -- use the configuration)`
	`45`	`+ */`
`37`	`46`	`public function __construct(UrlGeneratorInterface $generator, Profiler $profiler, \Twig_Environment $twig, array $templates, $toolbarPosition = 'normal')`
`38`	`47`	`{`
`39`	`48`	`$this->generator = $generator;`
`@@ -46,7 +55,7 @@ public function __construct(UrlGeneratorInterface $generator, Profiler $profiler`
`46`	`55`	`/**`
`47`	`56`	`* Renders a profiler panel for the given token.`
`48`	`57`	`*`
`49`		`- * @param Request $request The HTTP request`
	`58`	`+ * @param Request $request The current HTTP request`
`50`	`59`	`* @param string $token The profiler token`
`51`	`60`	`*`
`52`	`61`	`* @return Response A Response instance`
`@@ -115,7 +124,7 @@ public function purgeAction()`
`115`	`124`	`/**`
`116`	`125`	`* Imports token data.`
`117`	`126`	`*`
`118`		`- * @param Request $request`
	`127`	`+ * @param Request $request The current HTTP Request`
`119`	`128`	`*`
`120`	`129`	`* @return Response A Response instance`
`121`	`130`	`*/`
`@@ -139,7 +148,7 @@ public function importAction(Request $request)`
`139`	`148`	`/**`
`140`	`149`	`* Displays information page.`
`141`	`150`	`*`
`142`		`- * @param string $about`
	`151`	`+ * @param string $about The about message`
`143`	`152`	`*`
`144`	`153`	`* @return Response A Response instance`
`145`	`154`	`*/`
`@@ -155,7 +164,7 @@ public function infoAction($about)`
`155`	`164`	`/**`
`156`	`165`	`* Renders the Web Debug Toolbar.`
`157`	`166`	`*`
`158`		`- * @param Request $request The current Request`
	`167`	`+ * @param Request $request The current HTTP Request`
`159`	`168`	`* @param string $token The profiler token`
`160`	`169`	`* @param string $position The toolbar position (top, bottom, normal, or null -- use the configuration)`
`161`	`170`	`*`
`@@ -203,7 +212,7 @@ public function toolbarAction(Request $request, $token, $position = null)`
`203`	`212`	`/**`
`204`	`213`	`* Renders the profiler search bar.`
`205`	`214`	`*`
`206`		`- * @param Request $request The current Request`
	`215`	`+ * @param Request $request The current HTTP Request`
`207`	`216`	`*`
`208`	`217`	`* @return Response A Response instance`
`209`	`218`	`*/`
`@@ -237,8 +246,8 @@ public function searchBarAction(Request $request)`
`237`	`246`	`/**`
`238`	`247`	`* Search results.`
`239`	`248`	`*`
`240`		`- * @param Request $request The current Request`
`241`		`- * @param string $token The token`
	`249`	`+ * @param Request $request The current HTTP Request`
	`250`	`+ * @param string $token The token`
`242`	`251`	`*`
`243`	`252`	`* @return Response A Response instance`
`244`	`253`	`*/`
`@@ -268,7 +277,7 @@ public function searchResultsAction(Request $request, $token)`
`268`	`277`	`/**`
`269`	`278`	`* Narrow the search bar.`
`270`	`279`	`*`
`271`		`- * @param Request $request The current Request`
	`280`	`+ * @param Request $request The current HTTP Request`
`272`	`281`	`*`
`273`	`282`	`* @return Response A Response instance`
`274`	`283`	`*/`
`@@ -321,6 +330,11 @@ public function phpinfoAction()`
`321`	`330`	`return new Response($phpinfo);`
`322`	`331`	`}`
`323`	`332`
	`333`	`+ /**`
	`334`	`+ * Gets the Template Manager.`
	`335`	`+ *`
	`336`	`+ * @return TemplateManager The Template Manager`
	`337`	`+ */`
`324`	`338`	`protected function getTemplateManager()`
`325`	`339`	`{`
`326`	`340`	`if (null === $this->templateManager) {`