Skip to content

Commit 88367a6

Browse files
committed
Some Docblock love
1 parent 9cb1cc4 commit 88367a6

File tree

5 files changed

+22
-6
lines changed

5 files changed

+22
-6
lines changed

src/AutoloadRenderer.php

+4
Original file line numberDiff line numberDiff line change
@@ -189,6 +189,8 @@ public function getLineBreak() {
189189
* Setter to use allow usage of fixed date/time for ___CREATED___
190190
*
191191
* @param integer $time unix timestamp
192+
*
193+
* @throws AutoloadBuilderException
192194
*/
193195
public function setTimestamp($time) {
194196
if (!is_int($time) && !is_null($time)) {
@@ -255,6 +257,8 @@ private function resolvePath($fname) {
255257
/**
256258
* Render autoload code into a string
257259
*
260+
* @param string $template
261+
*
258262
* @return string
259263
*/
260264
public function render($template) {

src/Collector.php

+6-2
Original file line numberDiff line numberDiff line change
@@ -26,9 +26,13 @@ class Collector {
2626
private $trustingMode;
2727

2828
/**
29+
* Collector constructor.
30+
*
2931
* @param ParserInterface $parser
30-
* @param bool $tolerantMode
31-
* @param bool $trustingMode
32+
* @param bool $tolerantMode
33+
* @param bool $trustingMode
34+
* @param array $whitelist
35+
* @param array $blacklist
3236
*/
3337
public function __construct(ParserInterface $parser, $tolerantMode = false, $trustingMode = true, Array $whitelist = array('*'), Array $blacklist = array()) {
3438
$this->parser = $parser;

src/Factory.php

+6-2
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,8 @@
3737
*/
3838
namespace TheSeer\Autoload {
3939

40+
use TheSeer\DirectoryScanner\DirectoryScanner;
41+
4042
class Factory {
4143

4244
/**
@@ -120,10 +122,10 @@ public function getCollector() {
120122
* Get instance of DirectoryScanner with filter options applied
121123
*
122124
* @param bool $filter
123-
* @return \TheSeer\DirectoryScanner\DirectoryScanner
125+
* @return DirectoryScanner
124126
*/
125127
public function getScanner($filter = TRUE) {
126-
$scanner = new \TheSeer\DirectoryScanner\DirectoryScanner;
128+
$scanner = new DirectoryScanner;
127129
if ($filter) {
128130
$scanner->setIncludes($this->config->getInclude());
129131
$scanner->setExcludes($this->config->getExclude());
@@ -151,6 +153,8 @@ public function getPharBuilder() {
151153
/**
152154
* Helper to get instance of AutoloadRenderer with cli options applied
153155
*
156+
* @param CollectorResult $result
157+
*
154158
* @throws \RuntimeException
155159
* @return \TheSeer\Autoload\AutoloadRenderer|\TheSeer\Autoload\StaticRenderer
156160
*/

src/ParseResult.php

+3
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,9 @@ public function hasRedeclarations() {
3333
}
3434

3535
/**
36+
*
37+
* @param string $unit
38+
*
3639
* @return array
3740
*/
3841
public function getDependenciesForUnit($unit) {

src/StaticRenderer.php

+3-2
Original file line numberDiff line numberDiff line change
@@ -76,8 +76,9 @@ public function setRequireOnce($mode) {
7676
}
7777

7878
/**
79-
* (non-PHPdoc)
80-
* @see TheSeer\Autoload.AutoloadRenderer::render()
79+
* @param string $template
80+
*
81+
* @return string
8182
*/
8283
public function render($template) {
8384
$baseDir = '';

0 commit comments

Comments
 (0)