added a comment in PHPDoc about what should be a helper instance

2010-05-12 20:48:23 +02:00 · 2010-05-12 20:48:23 +02:00 · 9005efaa17
parent 10424155bf
commit 9005efaa17
1 changed files with 3 additions and 0 deletions
--- a/src/Symfony/Components/Templating/Helper/Helper.php
+++ b/src/Symfony/Components/Templating/Helper/Helper.php
@ -14,6 +14,9 @@ namespace Symfony\Components\Templating\Helper;
 /**
 * Helper is the base class for all helper classes.
 *
+ * Most of the time, a Helper is an adapter around an existing
+ * class that exposes a read-only interface for templates.
+ *
 * @package    Symfony
 * @subpackage Components_Templating
 * @author     Fabien Potencier <fabien.potencier@symfony-project.com>