Skip to content

Commit 32ef858

Browse files
ivanlaninivanlanin
committed
QA: Fix docblocks
1 parent 72b9074 commit 32ef858

File tree

19 files changed

+97
-32
lines changed

19 files changed

+97
-32
lines changed

‎Classes/PHPPowerPoint/Autoloader.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ public static function Register()
6161
/**
6262
* Autoload a class identified by name
6363
*
64-
* @param string $pClassName Name of the object to load
64+
* @param string $pObjectName Name of the object to load
6565
*/
6666
public static function Load($pObjectName)
6767
{

‎Classes/PHPPowerPoint/DocumentLayout.php

Lines changed: 19 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,9 @@ class PHPPowerPoint_DocumentLayout
5555
const LAYOUT_35mm = '35mm';
5656
// @codingStandardsIgnoreEnd
5757

58-
/*
58+
/**
59+
* Dimension types
60+
*
5961
* 1 px = 9525 EMU @ 96dpi (which is seems to be the default)
6062
* Absolute distances are specified in English Metric Units (EMUs),
6163
* occasionally referred to as A units; there are 360000 EMUs per
@@ -80,12 +82,24 @@ class PHPPowerPoint_DocumentLayout
8082
);
8183

8284
/**
83-
* Fill type
85+
* Layout name
8486
*
8587
* @var string
8688
*/
8789
private $_layout;
90+
91+
/**
92+
* Layout x dimension
93+
*
94+
* @var integer
95+
*/
8896
private $_cx;
97+
98+
/**
99+
* Layout y dimension
100+
*
101+
* @var integer
102+
*/
89103
private $_cy;
90104

91105
/**
@@ -112,10 +126,11 @@ public function getDocumentLayout()
112126
/**
113127
* Set Document Layout
114128
*
115-
* @param array $pValue PHPPowerPoint_DocumentLayout document layout
129+
* @param array $pValue PHPPowerPoint_DocumentLayout document layout
130+
* @param boolean $isLandscape
116131
* @return PHPPowerPoint_DocumentLayout
117132
*/
118-
public function setDocumentLayout($pValue = PHPPowerPoint_DocumentLayout::LAYOUT_SCREEN_4x3, $isLandscape = true)
133+
public function setDocumentLayout($pValue = PHPPowerPoint_DocumentLayout::LAYOUT_SCREEN_4X3, $isLandscape = true)
119134
{
120135
switch ($pValue) {
121136
case PHPPowerPoint_DocumentLayout::LAYOUT_SCREEN_4X3:

‎Classes/PHPPowerPoint/IOFactory.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -175,7 +175,7 @@ public static function createReader($readerType = '')
175175
/**
176176
* Loads PHPPowerPoint from file using automatic PHPPowerPoint_Reader_IReader resolution
177177
*
178-
* @param string $pFileName
178+
* @param string $pFilename
179179
* @return PHPPowerPoint
180180
* @throws Exception
181181
*/

‎Classes/PHPPowerPoint/Reader/IReader.php

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -37,15 +37,15 @@ interface PHPPowerPoint_Reader_IReader
3737
/**
3838
* Can the current PHPPowerPoint_Reader_IReader read the file?
3939
*
40-
* @param string $pFileName
40+
* @param string $pFilename
4141
* @return boolean
4242
*/
4343
public function canRead($pFilename);
4444

4545
/**
4646
* Loads PHPPowerPoint from file
4747
*
48-
* @param string $pFileName
48+
* @param string $pFilename
4949
* @throws Exception
5050
*/
5151
public function load($pFilename);

‎Classes/PHPPowerPoint/Reader/Serialized.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ class PHPPowerPoint_Reader_Serialized implements PHPPowerPoint_Reader_IReader
4848
/**
4949
* Can the current PHPPowerPoint_Reader_IReader read the file?
5050
*
51-
* @param string $pFileName
51+
* @param string $pFilename
5252
* @return boolean
5353
*/
5454
public function canRead($pFilename)

‎Classes/PHPPowerPoint/Shape/Line.php

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,10 @@ class PHPPowerPoint_Shape_Line extends PHPPowerPoint_Shape implements PHPPowerPo
3737
/**
3838
* Create a new PHPPowerPoint_Shape_Line instance
3939
*
40-
* @param int $columns Number of columns
40+
* @param int $fromX
41+
* @param int $fromY
42+
* @param int $toX
43+
* @param int $toY
4144
*/
4245
public function __construct($fromX, $fromY, $toX, $toY)
4346
{

‎Classes/PHPPowerPoint/Shape/RichText.php

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -194,6 +194,7 @@ public function setActiveParagraph($index = 0)
194194
/**
195195
* Get paragraph
196196
*
197+
* @param int $index
197198
* @return PHPPowerPoint_Shape_RichText_Paragraph
198199
*/
199200
public function getParagraph($index = 0)

‎Classes/PHPPowerPoint/Shape/Table/Cell.php

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -141,6 +141,7 @@ public function setActiveParagraph($index = 0)
141141
/**
142142
* Get paragraph
143143
*
144+
* @param int $index
144145
* @return PHPPowerPoint_Shape_RichText_Paragraph
145146
*/
146147
public function getParagraph($index = 0)

‎Classes/PHPPowerPoint/Shared/XMLWriter.php

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -99,27 +99,11 @@ public function __destruct()
9999
}
100100
}
101101

102-
/**
103-
* Get written data
104-
*
105-
* @return $data
106-
*/
107-
public function getData()
108-
{
109-
if ($this->_tempFileName == '') {
110-
return $this->_xmlWriter->outputMemory(true);
111-
} else {
112-
$this->_xmlWriter->flush();
113-
114-
return file_get_contents($this->_tempFileName);
115-
}
116-
}
117-
118102
/**
119103
* Catch function calls (and pass them to internal XMLWriter)
120104
*
121-
* @param unknown_type $function
122-
* @param unknown_type $args
105+
* @param mixed $function
106+
* @param mixed $args
123107
*/
124108
public function __call($function, $args)
125109
{
@@ -133,6 +117,22 @@ public function __call($function, $args)
133117
}
134118
}
135119

120+
/**
121+
* Get written data
122+
*
123+
* @return $data
124+
*/
125+
public function getData()
126+
{
127+
if ($this->_tempFileName == '') {
128+
return $this->_xmlWriter->outputMemory(true);
129+
} else {
130+
$this->_xmlWriter->flush();
131+
132+
return file_get_contents($this->_tempFileName);
133+
}
134+
}
135+
136136
/**
137137
* Fallback method for writeRaw, introduced in PHP 5.2
138138
*

‎Classes/PHPPowerPoint/Shared/ZipStreamWrapper.php

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -73,6 +73,11 @@ public static function register()
7373

7474
/**
7575
* Open stream
76+
*
77+
* @param string $path
78+
* @param string $mode
79+
* @param array $options
80+
* @param string $opened_path
7681
*/
7782
public function stream_open($path, $mode, $options, &$opened_path)
7883
{
@@ -121,6 +126,8 @@ public function stream_stat()
121126

122127
/**
123128
* Read stream
129+
*
130+
* @param int $count
124131
*/
125132
public function stream_read($count)
126133
{
@@ -148,6 +155,9 @@ public function stream_eof()
148155

149156
/**
150157
* Seek stream
158+
*
159+
* @param int $offset
160+
* @param int $whence
151161
*/
152162
public function stream_seek($offset, $whence)
153163
{

0 commit comments

Comments
 (0)