Docblock updates

Author: ivanlanin

samples/Sample_Footer.php

@@ -3,20 +3,20 @@
  * Footer file
  */
 // Do not show execution time for index
-if (!$isIndexFile) {
+if (!IS_INDEX) {
     echo date('H:i:s'), " Done writing file(s)", EOL;
     echo date('H:i:s'), " Peak memory usage: ", (memory_get_peak_usage(true) / 1024 / 1024), " MB", EOL;
 }
 // Show message when executed with CLI, show links when using browsers
 if (CLI) {
     echo 'The results are stored in the "results" subdirectory.', EOL;
 } else {
-    if (!$isIndexFile) {
+    if (!IS_INDEX) {
         $types = array('docx', 'odt', 'rtf');
         echo '<p>&nbsp;</p>';
         echo '<p>Results: ';
         foreach ($types as $type) {
-            $result = "results/{$sampleFile}.{$type}";
+            $result = 'results/' . SCRIPT_FILENAME . '.' . $type;
             if (file_exists($result)) {
                 echo "<a href='{$result}' class='btn btn-primary'>{$type}</a> ";
             }

samples/Sample_Header.php

@@ -5,6 +5,8 @@
 error_reporting(E_ALL);
 define('CLI', (PHP_SAPI == 'cli') ? true : false);
 define('EOL', CLI ? PHP_EOL : '<br />');
+define('SCRIPT_FILENAME', basename($_SERVER['SCRIPT_FILENAME'], '.php'));
+define('IS_INDEX', SCRIPT_FILENAME == 'index');
 
 require_once '../src/PhpWord/Autoloader.php';
 PhpOffice\PhpWord\Autoloader::register();
@@ -15,12 +17,10 @@
 }
 
 // Set titles and names
-$sampleFile = basename($_SERVER['SCRIPT_FILENAME'], '.php');
-$isIndexFile = ($sampleFile == 'index');
-$pageHeading = str_replace('_', ' ', $sampleFile);
-$pageTitle = $isIndexFile ? 'Welcome to ' : "{$pageHeading} - ";
+$pageHeading = str_replace('_', ' ', SCRIPT_FILENAME);
+$pageTitle = IS_INDEX ? 'Welcome to ' : "{$pageHeading} - ";
 $pageTitle .= 'PHPWord';
-$pageHeading = $isIndexFile ? '' : "<h1>{$pageHeading}</h1>";
+$pageHeading = IS_INDEX ? '' : "<h1>{$pageHeading}</h1>";
 // Populate samples
 $files = '';
 if ($handle = opendir('.')) {

src/PhpWord/Section.php

@@ -421,8 +421,9 @@ public function createFootnote($styleParagraph = null)
      *
      * @param string $name
      * @param string $text
-     * @param mixed $style
-     * @return PHPWord_Section_CheckBox
+     * @param mixed $styleFont
+     * @param mixed $styleParagraph
+     * @return \PhpOffice\PhpWord\Section\CheckBox
      */
     public function addCheckBox($name, $text, $styleFont = null, $styleParagraph = null)
     {

src/PhpWord/Section/CheckBox.php

@@ -129,6 +129,8 @@ public function getParagraphStyle()
     }
 
     /**
+     * Set name content
+     *
      * @param string $name
      * @return $this
      */
@@ -149,6 +151,8 @@ public function getName()
     }
 
     /**
+     * Set text content
+     *
      * @param string $text
      * @return $this
      */
@@ -159,7 +163,7 @@ public function setText($text)
     }
 
     /**
-     * Get Text content
+     * Get text content
      *
      * @return string
      */

src/PhpWord/Section/Table/Cell.php

@@ -296,8 +296,9 @@ public function createTextRun($styleParagraph = null)
      *
      * @param string $name
      * @param string $text
-     * @param mixed $style
-     * @return PHPWord_Section_CheckBox
+     * @param mixed $styleFont
+     * @param mixed $styleParagraph
+     * @return \PhpOffice\PhpWord\Section\CheckBox
      */
     public function addCheckBox($name, $text, $styleFont = null, $styleParagraph = null)
     {

src/PhpWord/Writer/Word2007/Base.php

@@ -1220,6 +1220,9 @@ protected function _writeFootnote(XMLWriter $xmlWriter, Footnote $footnote, $wit
 
     /**
      * Write CheckBox
+     *
+     * @param boolean $withoutP
+     * @param boolean $checkState
      */
     protected function _writeCheckBox(XMLWriter $xmlWriter, CheckBox $checkbox, $withoutP = false, $checkState = false)
     {

tests/PhpWord/Tests/Exceptions/ExceptionTest.php

@@ -20,6 +20,8 @@
 class ExceptionTest extends \PHPUnit_Framework_TestCase
 {
     /**
+     * Throw new exception
+     *
      * @expectedException \PhpOffice\PhpWord\Exceptions\Exception
      * @covers            \PhpOffice\PhpWord\Exceptions\Exception
      */

tests/PhpWord/Tests/Exceptions/InvalidImageExceptionTest.php

@@ -20,6 +20,8 @@
 class InvalidImageExceptionTest extends \PHPUnit_Framework_TestCase
 {
     /**
+     * Throw new exception
+     *
      * @expectedException \PhpOffice\PhpWord\Exceptions\InvalidImageException
      * @covers            \PhpOffice\PhpWord\Exceptions\InvalidImageException
      */

tests/PhpWord/Tests/Exceptions/InvalidStyleExceptionTest.php

@@ -20,6 +20,8 @@
 class InvalidStyleExceptionTest extends \PHPUnit_Framework_TestCase
 {
     /**
+     * Throw new exception
+     *
      * @expectedException \PhpOffice\PhpWord\Exceptions\InvalidStyleException
      * @covers            \PhpOffice\PhpWord\Exceptions\InvalidStyleException
      */

tests/PhpWord/Tests/Exceptions/UnsupportedImageTypeExceptionTest.php

@@ -20,6 +20,8 @@
 class UnsupportedImageTypeExceptionTest extends \PHPUnit_Framework_TestCase
 {
     /**
+     * Throw new exception
+     *
      * @expectedException \PhpOffice\PhpWord\Exceptions\UnsupportedImageTypeException
      * @covers            \PhpOffice\PhpWord\Exceptions\UnsupportedImageTypeException
      */