Update PHP doc everywhere.

This commit is contained in:
James Cole
2018-07-21 08:06:24 +02:00
parent 5ca4f1b181
commit 02f5eddd14
47 changed files with 363 additions and 111 deletions

View File

@@ -32,19 +32,20 @@ use Illuminate\Http\Response as LaravelResponse;
use Log;
/**
* Class FileController.
*
* Class IndexController
*/
class IndexController extends Controller
{
/** @var array */
public $providers;
/** @var ImportJobRepositoryInterface */
/** @var ImportJobRepositoryInterface The import job repository */
public $repository;
/** @var UserRepositoryInterface */
public $userRepository;
/**
*
* IndexController constructor.
*/
public function __construct()
{

View File

@@ -37,11 +37,11 @@ use Log;
*/
class JobConfigurationController extends Controller
{
/** @var ImportJobRepositoryInterface */
/** @var ImportJobRepositoryInterface The import job repository */
public $repository;
/**
*
* JobConfigurationController constructor.
*/
public function __construct()
{
@@ -162,6 +162,8 @@ class JobConfigurationController extends Controller
}
/**
* Make a configurator object.
*
* @param ImportJob $importJob
*
* @return JobConfigurationInterface

View File

@@ -37,11 +37,11 @@ use Log;
*/
class JobStatusController extends Controller
{
/** @var ImportJobRepositoryInterface */
/** @var ImportJobRepositoryInterface The import job repository */
private $repository;
/**
*
* JobStatusController constructor.
*/
public function __construct()
{
@@ -59,6 +59,8 @@ class JobStatusController extends Controller
}
/**
* Index for job status.
*
* @param ImportJob $importJob
*
* @return \Illuminate\Contracts\View\Factory|\Illuminate\View\View
@@ -72,6 +74,8 @@ class JobStatusController extends Controller
}
/**
* JSON overview of job status.
*
* @param ImportJob $importJob
*
* @return JsonResponse
@@ -120,6 +124,8 @@ class JobStatusController extends Controller
}
/**
* Calls to start the job.
*
* @param ImportJob $importJob
*
* @return JsonResponse
@@ -214,6 +220,8 @@ class JobStatusController extends Controller
}
/**
* Store the transactions.
*
* @param ImportJob $importJob
*
* @throws FireflyException

View File

@@ -36,11 +36,11 @@ use Log;
class PrerequisitesController extends Controller
{
/** @var ImportJobRepositoryInterface */
/** @var ImportJobRepositoryInterface The import job repository */
private $repository;
/**
*
* PrerequisitesController constructor.
*/
public function __construct()
{