Skip to content

Commit 34d1694

Browse files
committed
misc phpdoc updates
1 parent 203f0c0 commit 34d1694

File tree

3 files changed

+35
-16
lines changed

3 files changed

+35
-16
lines changed

src/Compiler.php

Lines changed: 19 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -429,8 +429,10 @@ protected function flattenSelectors(OutputBlock $block, $parentKey = null)
429429
}
430430

431431
/**
432-
* glue parts of :not( or :nth-child( ... that are in general splitted in selectors parts
432+
* Glue parts of :not( or :nth-child( ... that are in general splitted in selectors parts
433+
*
433434
* @param array $parts
435+
*
434436
* @return array
435437
*/
436438
protected function glueFunctionSelectors($parts)
@@ -1044,7 +1046,7 @@ protected function filterWithout($envs, $without)
10441046
/**
10451047
* Filter WITH rules
10461048
*
1047-
* @param integer $without
1049+
* @param integer $without
10481050
* @param \Leafo\ScssPhp\Block|\Leafo\ScssPhp\Formatter\OutputBlock $block
10491051
*
10501052
* @return boolean
@@ -1479,7 +1481,7 @@ protected function compileChildren($stms, OutputBlock $out)
14791481
*
14801482
* @param array $stms
14811483
* @param \Leafo\ScssPhp\Formatter\OutputBlock $out
1482-
* @param \Leafo\ScssPhp\Block $selfParent
1484+
* @param \Leafo\ScssPhp\Block $selfParent
14831485
*
14841486
* @throws \Exception
14851487
*/
@@ -1611,6 +1613,14 @@ protected function compileMediaQuery($queryList)
16111613
return $out;
16121614
}
16131615

1616+
/**
1617+
* Merge direct relationships between selectors
1618+
*
1619+
* @param array $selectors1
1620+
* @param array $selectors2
1621+
*
1622+
* @return array
1623+
*/
16141624
protected function mergeDirectRelationships($selectors1, $selectors2)
16151625
{
16161626
if (empty($selectors1) || empty($selectors2)) {
@@ -1711,9 +1721,9 @@ protected function mergeMediaTypes($type1, $type2)
17111721
/**
17121722
* Compile import; returns true if the value was something that could be imported
17131723
*
1714-
* @param array $rawPath
1715-
* @param OutputBlock $out
1716-
* @param boolean $once
1724+
* @param array $rawPath
1725+
* @param \Leafo\ScssPhp\Formatter\OutputBlock $out
1726+
* @param boolean $once
17171727
*
17181728
* @return boolean
17191729
*/
@@ -3142,7 +3152,7 @@ protected function extractInterpolation($list)
31423152
* Find the final set of selectors
31433153
*
31443154
* @param \Leafo\ScssPhp\Compiler\Environment $env
3145-
* @param Leafo\ScssPhp\Block $selfParent
3155+
* @param \Leafo\ScssPhp\Block $selfParent
31463156
*
31473157
* @return array
31483158
*/
@@ -3736,8 +3746,8 @@ public function addFeature($name)
37363746
/**
37373747
* Import file
37383748
*
3739-
* @param OutputBlock $path
3740-
* @param array $out
3749+
* @param string $path
3750+
* @param \Leafo\ScssPhp\Formatter\OutputBlock $out
37413751
*/
37423752
protected function importFile($path, OutputBlock $out)
37433753
{

src/Parser.php

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1265,9 +1265,9 @@ protected function expression(&$out)
12651265
/**
12661266
* Parse expression specifically checking for lists in parenthesis or brackets
12671267
*
1268-
* @param array $out
1268+
* @param array $out
12691269
* @param integer $s
1270-
* @param string $closingParen
1270+
* @param string $closingParen
12711271
*
12721272
* @return boolean
12731273
*/
@@ -1540,7 +1540,7 @@ protected function progid(&$out)
15401540
* Parse function call
15411541
*
15421542
* @param string $name
1543-
* @param array $func
1543+
* @param array $func
15441544
*
15451545
* @return boolean
15461546
*/

src/SourceMap/SourceMapGenerator.php

Lines changed: 13 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -110,11 +110,11 @@ public function __construct(array $options = [])
110110
public function addMapping($generatedLine, $generatedColumn, $originalLine, $originalColumn, $sourceFile)
111111
{
112112
$this->mappings[] = [
113-
'generated_line' => $generatedLine,
113+
'generated_line' => $generatedLine,
114114
'generated_column' => $generatedColumn,
115-
'original_line' => $originalLine,
116-
'original_column' => $originalColumn,
117-
'source_file' => $sourceFile
115+
'original_line' => $originalLine,
116+
'original_column' => $originalColumn,
117+
'source_file' => $sourceFile
118118
];
119119

120120
$this->sources[$sourceFile] = $sourceFile;
@@ -125,6 +125,8 @@ public function addMapping($generatedLine, $generatedColumn, $originalLine, $ori
125125
*
126126
* @param string $content The content to write
127127
*
128+
* @return string
129+
*
128130
* @throws \Leafo\ScssPhp\Exception\CompilerException If the file could not be saved
129131
*/
130132
public function saveMap($content)
@@ -295,6 +297,13 @@ protected function findFileIndex($filename)
295297
return $this->source_keys[$filename];
296298
}
297299

300+
/**
301+
* Normalize filename
302+
*
303+
* @param string $filename
304+
*
305+
* @return string
306+
*/
298307
protected function normalizeFilename($filename)
299308
{
300309
$filename = $this->fixWindowsPath($filename);

0 commit comments

Comments
 (0)