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

@@ -55,6 +55,8 @@ class ConfigurationController extends Controller
}
/**
* Show configuration index.
*
* @return \Illuminate\Contracts\View\Factory|\Illuminate\View\View
*/
public function index()
@@ -75,6 +77,8 @@ class ConfigurationController extends Controller
}
/**
* Store new configuration values.
*
* @param ConfigurationRequest $request
*
* @return RedirectResponse

View File

@@ -46,6 +46,8 @@ class HomeController extends Controller
}
/**
* Index of the admin.
*
* @return \Illuminate\Contracts\View\Factory|\Illuminate\View\View
*/
public function index()
@@ -58,6 +60,8 @@ class HomeController extends Controller
}
/**
* Send a test message to the admin.
*
* @param Request $request
*
* @return \Illuminate\Http\RedirectResponse|\Illuminate\Routing\Redirector

View File

@@ -36,7 +36,7 @@ use View;
class LinkController extends Controller
{
/**
*
* LinkController constructor.
*/
public function __construct()
{
@@ -54,6 +54,7 @@ class LinkController extends Controller
}
/**
* Make a new link form.
* @return \Illuminate\Contracts\View\Factory|\Illuminate\View\View
*/
public function create()
@@ -70,6 +71,8 @@ class LinkController extends Controller
}
/**
* Delete a link form.
*
* @param Request $request
* @param LinkTypeRepositoryInterface $repository
* @param LinkType $linkType
@@ -102,6 +105,8 @@ class LinkController extends Controller
}
/**
* Actually destroy the link.
*
* @param Request $request
* @param LinkTypeRepositoryInterface $repository
* @param LinkType $linkType
@@ -121,6 +126,8 @@ class LinkController extends Controller
}
/**
* Edit a link form.
*
* @param Request $request
* @param LinkType $linkType
*
@@ -146,6 +153,8 @@ class LinkController extends Controller
}
/**
* Show index of all links.
*
* @param LinkTypeRepositoryInterface $repository
*
* @return \Illuminate\Contracts\View\Factory|\Illuminate\View\View
@@ -165,6 +174,8 @@ class LinkController extends Controller
}
/**
* Show a single link.
*
* @param LinkType $linkType
*
* @return \Illuminate\Contracts\View\Factory|\Illuminate\View\View
@@ -179,6 +190,8 @@ class LinkController extends Controller
}
/**
* Store the new link.
*
* @param LinkTypeFormRequest $request
* @param LinkTypeRepositoryInterface $repository
*
@@ -206,6 +219,8 @@ class LinkController extends Controller
}
/**
* Update an existing link.
*
* @param LinkTypeFormRequest $request
* @param LinkTypeRepositoryInterface $repository
* @param LinkType $linkType

View File

@@ -56,6 +56,8 @@ class UpdateController extends Controller
}
/**
* Show page with update options.
*
* @return \Illuminate\Contracts\View\Factory|\Illuminate\View\View
* @throws \Psr\Container\NotFoundExceptionInterface
* @throws \Psr\Container\ContainerExceptionInterface
@@ -76,6 +78,8 @@ class UpdateController extends Controller
}
/**
* Post new settings.
*
* @param Request $request
*
* @return \Illuminate\Http\RedirectResponse|\Illuminate\Routing\Redirector

View File

@@ -36,7 +36,7 @@ use Log;
class UserController extends Controller
{
/**
*
* UserController constructor.
*/
public function __construct()
{
@@ -55,6 +55,8 @@ class UserController extends Controller
}
/**
* Delete a user.
*
* @param User $user
*
* @return \Illuminate\Contracts\View\Factory|\Illuminate\View\View
@@ -67,6 +69,8 @@ class UserController extends Controller
}
/**
* Destroy a user.
*
* @param User $user
* @param UserRepositoryInterface $repository
*
@@ -81,6 +85,8 @@ class UserController extends Controller
}
/**
* Edit user form.
*
* @param User $user
*
* @return \Illuminate\Contracts\View\Factory|\Illuminate\View\View
@@ -106,6 +112,8 @@ class UserController extends Controller
}
/**
* Show index of user manager.
*
* @param UserRepositoryInterface $repository
*
* @return \Illuminate\Contracts\View\Factory|\Illuminate\View\View
@@ -133,6 +141,8 @@ class UserController extends Controller
}
/**
* Show single user.
*
* @param UserRepositoryInterface $repository
* @param User $user
*
@@ -154,6 +164,8 @@ class UserController extends Controller
}
/**
* Update single user.
*
* @param UserFormRequest $request
* @param User $user
* @param UserRepositoryInterface $repository