Skip to content

Commit fca9e53

Browse files
ivanlaninivanlanin
committed
DocBlock corrections
1 parent 12a7977 commit fca9e53

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

51 files changed

+984
-109
lines changed

‎Classes/PHPWord.php

Lines changed: 13 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -188,8 +188,8 @@ public function setDefaultParagraphStyle($styles)
188188
/**
189189
* Adds a paragraph style definition to styles.xml
190190
*
191-
* @param $styleName string
192-
* @param $styles array
191+
* @param string $styleName
192+
* @param array $styles
193193
*/
194194
public function addParagraphStyle($styleName, $styles)
195195
{
@@ -199,8 +199,9 @@ public function addParagraphStyle($styleName, $styles)
199199
/**
200200
* Adds a font style definition to styles.xml
201201
*
202-
* @param $styleName string
203-
* @param $styles array
202+
* @param string $styleName
203+
* @param array $styleFont
204+
* @param array $styleParagraph
204205
*/
205206
public function addFontStyle($styleName, $styleFont, $styleParagraph = null)
206207
{
@@ -210,8 +211,9 @@ public function addFontStyle($styleName, $styleFont, $styleParagraph = null)
210211
/**
211212
* Adds a table style definition to styles.xml
212213
*
213-
* @param $styleName string
214-
* @param $styles array
214+
* @param string $styleName
215+
* @param array $styleTable
216+
* @param array $styleFirstRow
215217
*/
216218
public function addTableStyle($styleName, $styleTable, $styleFirstRow = null)
217219
{
@@ -221,8 +223,9 @@ public function addTableStyle($styleName, $styleTable, $styleFirstRow = null)
221223
/**
222224
* Adds a heading style definition to styles.xml
223225
*
224-
* @param $titleCount int
225-
* @param $styles array
226+
* @param int $titleCount
227+
* @param array $styleFont
228+
* @param array $styleParagraph
226229
*/
227230
public function addTitleStyle($titleCount, $styleFont, $styleParagraph = null)
228231
{
@@ -232,8 +235,8 @@ public function addTitleStyle($titleCount, $styleFont, $styleParagraph = null)
232235
/**
233236
* Adds a hyperlink style to styles.xml
234237
*
235-
* @param $styleName string
236-
* @param $styles array
238+
* @param string $styleName
239+
* @param array $styles
237240
*/
238241
public function addLinkStyle($styleName, $styles)
239242
{

‎Classes/PHPWord/Autoloader.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ public static function load($strObjectName)
6969
/**
7070
* Autoloader
7171
*
72-
* @param string
72+
* @param string $class
7373
*/
7474
public static function autoload($class)
7575
{

‎Classes/PHPWord/Exceptions/Exception.php

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,29 @@
11
<?php
2+
/**
3+
* PHPWord
4+
*
5+
* Copyright (c) 2014 PHPWord
6+
*
7+
* This library is free software; you can redistribute it and/or
8+
* modify it under the terms of the GNU Lesser General Public
9+
* License as published by the Free Software Foundation; either
10+
* version 2.1 of the License, or (at your option) any later version.
11+
*
12+
* This library is distributed in the hope that it will be useful,
13+
* but WITHOUT ANY WARRANTY; without even the implied warranty of
14+
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15+
* Lesser General Public License for more details.
16+
*
17+
* You should have received a copy of the GNU Lesser General Public
18+
* License along with this library; if not, write to the Free Software
19+
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
20+
*
21+
* @category PHPWord
22+
* @package PHPWord
23+
* @copyright Copyright (c) 2014 PHPWord
24+
* @license http://www.gnu.org/licenses/old-licenses/lgpl-2.1.txt LGPL
25+
* @version 0.8.0
26+
*/
227
namespace PhpOffice\PhpWord\Exceptions;
328

429
/**

‎Classes/PHPWord/Exceptions/InvalidImageException.php

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,29 @@
11
<?php
2+
/**
3+
* PHPWord
4+
*
5+
* Copyright (c) 2014 PHPWord
6+
*
7+
* This library is free software; you can redistribute it and/or
8+
* modify it under the terms of the GNU Lesser General Public
9+
* License as published by the Free Software Foundation; either
10+
* version 2.1 of the License, or (at your option) any later version.
11+
*
12+
* This library is distributed in the hope that it will be useful,
13+
* but WITHOUT ANY WARRANTY; without even the implied warranty of
14+
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15+
* Lesser General Public License for more details.
16+
*
17+
* You should have received a copy of the GNU Lesser General Public
18+
* License along with this library; if not, write to the Free Software
19+
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
20+
*
21+
* @category PHPWord
22+
* @package PHPWord
23+
* @copyright Copyright (c) 2014 PHPWord
24+
* @license http://www.gnu.org/licenses/old-licenses/lgpl-2.1.txt LGPL
25+
* @version 0.8.0
26+
*/
227
namespace PhpOffice\PhpWord\Exceptions;
328

429
/**

‎Classes/PHPWord/Exceptions/InvalidStyleException.php

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,29 @@
11
<?php
2+
/**
3+
* PHPWord
4+
*
5+
* Copyright (c) 2014 PHPWord
6+
*
7+
* This library is free software; you can redistribute it and/or
8+
* modify it under the terms of the GNU Lesser General Public
9+
* License as published by the Free Software Foundation; either
10+
* version 2.1 of the License, or (at your option) any later version.
11+
*
12+
* This library is distributed in the hope that it will be useful,
13+
* but WITHOUT ANY WARRANTY; without even the implied warranty of
14+
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15+
* Lesser General Public License for more details.
16+
*
17+
* You should have received a copy of the GNU Lesser General Public
18+
* License along with this library; if not, write to the Free Software
19+
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
20+
*
21+
* @category PHPWord
22+
* @package PHPWord
23+
* @copyright Copyright (c) 2014 PHPWord
24+
* @license http://www.gnu.org/licenses/old-licenses/lgpl-2.1.txt LGPL
25+
* @version 0.8.0
26+
*/
227
namespace PhpOffice\PhpWord\Exceptions;
328

429
use InvalidArgumentException;

‎Classes/PHPWord/Exceptions/UnsupportedImageTypeException.php

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,29 @@
11
<?php
2+
/**
3+
* PHPWord
4+
*
5+
* Copyright (c) 2014 PHPWord
6+
*
7+
* This library is free software; you can redistribute it and/or
8+
* modify it under the terms of the GNU Lesser General Public
9+
* License as published by the Free Software Foundation; either
10+
* version 2.1 of the License, or (at your option) any later version.
11+
*
12+
* This library is distributed in the hope that it will be useful,
13+
* but WITHOUT ANY WARRANTY; without even the implied warranty of
14+
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15+
* Lesser General Public License for more details.
16+
*
17+
* You should have received a copy of the GNU Lesser General Public
18+
* License along with this library; if not, write to the Free Software
19+
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
20+
*
21+
* @category PHPWord
22+
* @package PHPWord
23+
* @copyright Copyright (c) 2014 PHPWord
24+
* @license http://www.gnu.org/licenses/old-licenses/lgpl-2.1.txt LGPL
25+
* @version 0.8.0
26+
*/
227
namespace PhpOffice\PhpWord\Exceptions;
328

429
/**

‎Classes/PHPWord/Footnote.php

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -86,8 +86,7 @@ public static function countFootnoteElements()
8686
/**
8787
* Add new Footnote Link Element
8888
*
89-
* @param string $src
90-
* @param string $type
89+
* @param string $linkSrc
9190
*
9291
* @return mixed
9392
*/

‎Classes/PHPWord/Reader/Abstract.php

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,8 @@ abstract class PHPWord_Reader_Abstract implements PHPWord_Reader_IReader
4242
protected $readDataOnly = true;
4343

4444
/**
45+
* File pointer
46+
*
4547
* @var bool|resource
4648
*/
4749
protected $fileHandle = true;

‎Classes/PHPWord/Section/Footer.php

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,8 @@ class PHPWord_Section_Footer
5454

5555
/**
5656
* Create a new Footer
57+
*
58+
* @param int $sectionCount
5759
*/
5860
public function __construct($sectionCount)
5961
{
@@ -95,6 +97,7 @@ public function addTextBreak($count = 1, $fontStyle = null, $paragraphStyle = nu
9597
/**
9698
* Create a new TextRun
9799
*
100+
* @param null|string|array|PHPWord_Style_Paragraph $styleParagraph
98101
* @return PHPWord_Section_TextRun
99102
*/
100103
public function createTextRun($styleParagraph = null)

‎Classes/PHPWord/Section/Footer/PreserveText.php

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -56,8 +56,10 @@ class PHPWord_Section_Footer_PreserveText
5656
/**
5757
* Create a new Preserve Text Element
5858
*
59-
* @var string $text
60-
* @var mixed $style
59+
* @param string $text
60+
* @param mixed $styleFont
61+
* @param mixed $styleParagraph
62+
* @return PHPWord_Section_Footer_PreserveText
6163
*/
6264
public function __construct($text = null, $styleFont = null, $styleParagraph = null)
6365
{

0 commit comments

Comments
 (0)