Browse Source

Add description for FlashHelper class, fix typo in render() docblock

Bryan Crowe 11 years ago
parent
commit
f70b72ca1c
1 changed files with 5 additions and 2 deletions
  1. 5 2
      src/View/Helper/FlashHelper.php

+ 5 - 2
src/View/Helper/FlashHelper.php

@@ -19,7 +19,10 @@ use Cake\View\Helper;
 use Cake\View\View;
 
 /**
- * FlashHelper
+ * FlashHelper class to render flash messages.
+ *
+ * After setting messsages in your controllers with FlashComponent, you can use
+ * this class to output your flash messages in your views.
  */
 class FlashHelper extends Helper {
 
@@ -37,7 +40,7 @@ class FlashHelper extends Helper {
 	];
 
 /**
- * Used to render the message set in FlashCompnet::set()
+ * Used to render the message set in FlashComponent::set()
  *
  * In your view: $this->Flash->render('somekey');
  * Will default to flash if no param is passed