Tidied up the readme a bit, also broke up the doc blocks and added missing return types

Author: davidyell

README.md

@@ -23,7 +23,7 @@ composer require 'davidyell/nice-admin-bake-scripts:dev-master'
 ```
 
 ## Setup
-In your `src/config/bootstrap.php` you'll need to load the plugin with `Plugin::load('NiceAdminBakeTheme');`
+In your `config/bootstrap.php` you'll need to load the plugin with `Plugin::load('NiceAdminBakeTheme');`
 
 In your admin layout, you'll need to include the theme and javascript.
 

src/Template/Bake/Element/Controller/add.ctp

@@ -18,7 +18,7 @@ $compact = ["'" . $singularName . "'"];
     /**
      * Add method
      *
-     * @return void Redirects on successful add, renders view otherwise.
+     * @return \Cake\Network\Response|void Redirects on successful add, renders view otherwise.
      */
     public function add()
     {

src/Template/Bake/Element/Controller/edit.ctp

@@ -22,7 +22,9 @@ $compact = ["'" . $singularName . "'"];
      * Edit method
      *
      * @param string|null $id <%= $singularHumanName %> id.
-     * @return void Redirects on successful edit, renders view otherwise.
+     *
+     * @return \Cake\Network\Response|void Redirects on successful edit, renders view otherwise.
+     *
      * @throws \Cake\Network\Exception\NotFoundException When record not found.
      */
     public function edit($id = null)

src/Template/Bake/Element/Controller/view.ctp

@@ -24,7 +24,9 @@ $allAssociations = array_merge(
      * View method
      *
      * @param string|null $id <%= $singularHumanName %> id.
+     *
      * @return void
+     *
      * @throws \Cake\Network\Exception\NotFoundException When record not found.
      */
     public function view($id = null)

src/Template/Bake/Model/table.ctp

@@ -35,6 +35,7 @@ class <%= $name %>Table extends Table
      * Initialize method
      *
      * @param array $config The configuration for the Table.
+     *
      * @return void
      */
     public function initialize(array $config)
@@ -72,6 +73,7 @@ class <%= $name %>Table extends Table
      * Default validation rules.
      *
      * @param \Cake\Validation\Validator $validator Validator instance.
+     *
      * @return \Cake\Validation\Validator
      */
     public function validationDefault(Validator $validator)
@@ -144,6 +146,7 @@ endforeach;
      * application integrity.
      *
      * @param \Cake\ORM\RulesChecker $rules The rules object to be modified.
+     *
      * @return \Cake\ORM\RulesChecker
      */
     public function buildRules(RulesChecker $rules)

src/Template/Element/navigation.ctp

@@ -1,5 +1,8 @@
 <div class="user">
-    <?= $this->Gravatar->avatar($this->request->session()->read('Auth.User.email'), 40);?>
+    <?php
+    $hash = md5(strtolower(trim($this->request->session()->read('Auth.User.email'))));
+    echo "<img class='$class' src='http://www.gravatar.com/avatar/$hash?s=$size&d=mm'>";
+    ?>
     <p>
         <?= $this->request->session()->read('Auth.User.first_name') . ' ' . $this->request->session()->read('Auth.User.last_name')?><br>
         <span class="status online"><i class="glyphicon glyphicon-ok-sign"></i></span> Online

src/Template/Element/top-navigation.ctp

@@ -11,9 +11,15 @@
         </div>
         <div id="navbar" class="navbar-collapse collapse">
             <ul class="nav navbar-nav navbar-right">
-                <li <?php echo ($this->request->controller == 'Dashboards')? "class='active'" : '';?>><?php echo $this->Html->link('<i class="glyphicon glyphicon-home"></i> Dashboard', ['controller' => 'Dashboards', 'action' => 'home', 'plugin' => false], ['escape' => false]); ?></li>
-                <li <?php echo (isset($this->request->params['pass'][0]) && $this->request->params['pass'][0] == 'help')? "class='active'" : '';?>><?php echo $this->Html->link('<i class="glyphicon glyphicon-question-sign"></i> Help', ['controller' => 'Pages', 'action' => 'display', 'help', 'prefix' => 'admin', 'plugin' => false], ['escape' => false]); ?></li>
-                <li><?php echo $this->Html->link('<i class="glyphicon glyphicon-off"></i> Logout', ['controller' => 'Users', 'action' => 'logout', 'plugin' => false, 'prefix' => false], ['escape' => false]); ?></li>
+                <li <?php echo ($this->request->controller == 'Dashboards')? "class='active'" : '';?>>
+                    <?php echo $this->Html->link('<i class="glyphicon glyphicon-home"></i> Dashboard', ['controller' => 'Dashboards', 'action' => 'home', 'plugin' => false], ['escape' => false]); ?>
+                </li>
+                <li <?php echo (isset($this->request->params['pass'][0]) && $this->request->params['pass'][0] == 'help')? "class='active'" : '';?>>
+                    <?php echo $this->Html->link('<i class="glyphicon glyphicon-question-sign"></i> Help', ['controller' => 'Pages', 'action' => 'display', 'help', 'prefix' => 'admin', 'plugin' => false], ['escape' => false]); ?>
+                </li>
+                <li>
+                    <?php echo $this->Html->link('<i class="glyphicon glyphicon-off"></i> Logout', ['controller' => 'Users', 'action' => 'logout', 'plugin' => false, 'prefix' => false], ['escape' => false]); ?>
+                </li>
             </ul>
         </div>
     </div>