fix documentation

PHPOffice · Jul 14, 2018 · 6475812 · 6475812
1 parent 3290721
commit 6475812
Show file tree

Hide file tree

Showing 6 changed files with 12 additions and 16 deletions.
diff --git a/src/PhpWord/Element/OLEObject.php b/src/PhpWord/Element/OLEObject.php
@@ -83,7 +83,7 @@ public function __construct($source, $style = null)
  $this->style = $this->setNewStyle(new ImageStyle(), $style, true);
  $this->icon = realpath(__DIR__ . "/../resources/{$ext}.png");
 
- return $this;
+ return;
  }
 
  throw new InvalidObjectException();

diff --git a/src/PhpWord/Element/PreserveText.php b/src/PhpWord/Element/PreserveText.php
@@ -29,7 +29,7 @@ class PreserveText extends AbstractElement
  /**
  * Text content
  *
- * @var string
+ * @var string|array
  */
  private $text;
 
@@ -64,8 +64,6 @@ public function __construct($text = null, $fontStyle = null, $paragraphStyle = n
  if (isset($matches[0])) {
  $this->text = $matches;
  }
-
- return $this;
  }
 
  /**
@@ -91,7 +89,7 @@ public function getParagraphStyle()
  /**
  * Get Text content
  *
- * @return string
+ * @return string|array
  */
  public function getText()
  {

diff --git a/src/PhpWord/Element/Title.php b/src/PhpWord/Element/Title.php
@@ -74,8 +74,6 @@ public function __construct($text, $depth = 1)
  if (array_key_exists($styleName, Style::getStyles())) {
  $this->style = str_replace('_', '', $styleName);
  }
-
- return $this;
  }
 
  /**

diff --git a/src/PhpWord/Metadata/Protection.php b/src/PhpWord/Metadata/Protection.php
@@ -113,7 +113,7 @@ public function getPassword()
  /**
  * Set password
  *
- * @param $password
+ * @param string $password
  * @return self
  */
  public function setPassword($password)
@@ -136,7 +136,7 @@ public function getSpinCount()
  /**
  * Set count for hash iterations
  *
- * @param $spinCount
+ * @param int $spinCount
  * @return self
  */
  public function setSpinCount($spinCount)
@@ -159,7 +159,7 @@ public function getAlgorithm()
  /**
  * Set algorithm
  *
- * @param $algorithm
+ * @param string $algorithm
  * @return self
  */
  public function setAlgorithm($algorithm)

diff --git a/src/PhpWord/Reader/Word2007/Settings.php b/src/PhpWord/Reader/Word2007/Settings.php
@@ -81,7 +81,7 @@ public function read(PhpWord $phpWord)
  *
  * @param XMLReader $xmlReader
  * @param PhpWord $phpWord
- * @param \DOMNode $node
+ * @param \DOMElement $node
  */
  protected function setThemeFontLang(XMLReader $xmlReader, PhpWord $phpWord, \DOMElement $node)
  {
@@ -102,7 +102,7 @@ protected function setThemeFontLang(XMLReader $xmlReader, PhpWord $phpWord, \DOM
  *
  * @param XMLReader $xmlReader
  * @param PhpWord $phpWord
- * @param \DOMNode $node
+ * @param \DOMElement $node
  */
  protected function setDocumentProtection(XMLReader $xmlReader, PhpWord $phpWord, \DOMElement $node)
  {
@@ -119,7 +119,7 @@ protected function setDocumentProtection(XMLReader $xmlReader, PhpWord $phpWord,
  *
  * @param XMLReader $xmlReader
  * @param PhpWord $phpWord
- * @param \DOMNode $node
+ * @param \DOMElement $node
  */
  protected function setProofState(XMLReader $xmlReader, PhpWord $phpWord, \DOMElement $node)
  {
@@ -141,7 +141,7 @@ protected function setProofState(XMLReader $xmlReader, PhpWord $phpWord, \DOMEle
  *
  * @param XMLReader $xmlReader
  * @param PhpWord $phpWord
- * @param \DOMNode $node
+ * @param \DOMElement $node
  */
  protected function setZoom(XMLReader $xmlReader, PhpWord $phpWord, \DOMElement $node)
  {
@@ -158,7 +158,7 @@ protected function setZoom(XMLReader $xmlReader, PhpWord $phpWord, \DOMElement $
  *
  * @param XMLReader $xmlReader
  * @param PhpWord $phpWord
- * @param \DOMNode $node
+ * @param \DOMElement $node
  */
  protected function setRevisionView(XMLReader $xmlReader, PhpWord $phpWord, \DOMElement $node)
  {

diff --git a/src/PhpWord/Writer/RTF/Style/Indentation.php b/src/PhpWord/Writer/RTF/Style/Indentation.php
@@ -33,7 +33,7 @@ public function write()
  {
  $style = $this->getStyle();
  if (!$style instanceof \PhpOffice\PhpWord\Style\Indentation) {
- return;
+ return '';
  }
 
  $content = '\fi' . $style->getFirstLine();