Doc and style

This commit is contained in:
An Phan 2016-02-03 23:39:15 +08:00
parent e0004718e5
commit 5262fee853
7 changed files with 26 additions and 11 deletions

View file

@ -61,7 +61,7 @@ class Application extends IlluminateApplication
* If this installation of Koel has a CDN_URL configured, use it as the base.
* Otherwise, just use a relative '/'.
*
* @param string The additional resource name/path.
* @param string $name The additional resource name/path.
*
* @return string
*/
@ -72,7 +72,9 @@ class Application extends IlluminateApplication
/**
* Get the latest version number of Koel from Github.
*
*
* @param Client $client
*
* @return string
*/
public function getLatestVersion(Client $client = null)

View file

@ -13,15 +13,15 @@ class Kernel extends ConsoleKernel
* @var array
*/
protected $commands = [
\App\Console\Commands\SyncMedia::class,
\App\Console\Commands\Init::class,
\App\Console\Commands\GenerateJWTSecret::class,
Commands\SyncMedia::class,
Commands\Init::class,
Commands\GenerateJWTSecret::class,
];
/**
* Define the application's command schedule.
*
* @param \Illuminate\Console\Scheduling\Schedule $schedule
* @param Schedule $schedule
*
* @return void
*/

View file

@ -11,7 +11,7 @@ class SongLikeToggled extends Event
use SerializesModels;
/**
* The ineraction (like/unlike) in action.
* The interaction (like/unlike) in action.
*
* @var Interaction
*/
@ -29,8 +29,6 @@ class SongLikeToggled extends Event
*
* @param Interaction $interaction
* @param User $user
*
* @return void
*/
public function __construct(Interaction $interaction, User $user = null)
{

View file

@ -26,6 +26,9 @@ class SongStartedPlaying extends Event
/**
* Create a new event instance.
*
* @param Song $song
* @param User $user
*/
public function __construct(Song $song, User $user)
{

View file

@ -16,7 +16,9 @@ class UserController extends Controller
{
/**
* Log a user in.
*
*
* @param UserLoginRequest $request
*
* @return \Illuminate\Http\JsonResponse
*/
public function login(UserLoginRequest $request)

View file

@ -17,6 +17,8 @@ class UpdateLastfmNowPlaying
/**
* Create the event listener.
*
* @param Lastfm $lastfm
*/
public function __construct(Lastfm $lastfm)
{

View file

@ -4,6 +4,11 @@ namespace App\Models;
use Illuminate\Foundation\Auth\User as Authenticatable;
/**
* @property array preferences
* @property int id
* @property bool is_admin
*/
class User extends Authenticatable
{
/**
@ -80,8 +85,11 @@ class User extends Authenticatable
/**
* An alias to savePreference().
*
*
* @see $this::savePreference
*
* @param $key
* @param $val
*/
public function setPreference($key, $val)
{