Skip to content

Commit

Permalink
Doc and style
Browse files Browse the repository at this point in the history
  • Loading branch information
An Phan committed Feb 3, 2016
1 parent e000471 commit 5262fee
Show file tree
Hide file tree
Showing 7 changed files with 26 additions and 11 deletions.
6 changes: 4 additions & 2 deletions app/Application.php
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ public function rev($file, $manifestFile = null)
* 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
*/
Expand All @@ -72,7 +72,9 @@ public function staticUrl($name = null)

/**
* Get the latest version number of Koel from Github.
*
*
* @param Client $client
*
* @return string
*/
public function getLatestVersion(Client $client = null)
Expand Down
8 changes: 4 additions & 4 deletions app/Console/Kernel.php
Original file line number Diff line number Diff line change
Expand Up @@ -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
*/
Expand Down
4 changes: 1 addition & 3 deletions app/Events/SongLikeToggled.php
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ class SongLikeToggled extends Event
use SerializesModels;

/**
* The ineraction (like/unlike) in action.
* The interaction (like/unlike) in action.
*
* @var Interaction
*/
Expand All @@ -29,8 +29,6 @@ class SongLikeToggled extends Event
*
* @param Interaction $interaction
* @param User $user
*
* @return void
*/
public function __construct(Interaction $interaction, User $user = null)
{
Expand Down
3 changes: 3 additions & 0 deletions app/Events/SongStartedPlaying.php
Original file line number Diff line number Diff line change
Expand Up @@ -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)
{
Expand Down
4 changes: 3 additions & 1 deletion app/Http/Controllers/API/UserController.php
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,9 @@ class UserController extends Controller
{
/**
* Log a user in.
*
*
* @param UserLoginRequest $request
*
* @return \Illuminate\Http\JsonResponse
*/
public function login(UserLoginRequest $request)
Expand Down
2 changes: 2 additions & 0 deletions app/Listeners/UpdateLastfmNowPlaying.php
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,8 @@ class UpdateLastfmNowPlaying

/**
* Create the event listener.
*
* @param Lastfm $lastfm
*/
public function __construct(Lastfm $lastfm)
{
Expand Down
10 changes: 9 additions & 1 deletion app/Models/User.php
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,11 @@

use Illuminate\Foundation\Auth\User as Authenticatable;

/**
* @property array preferences
* @property int id
* @property bool is_admin
*/
class User extends Authenticatable
{
/**
Expand Down Expand Up @@ -80,8 +85,11 @@ public function savePreference($key, $val)

/**
* An alias to savePreference().
*
*
* @see $this::savePreference
*
* @param $key
* @param $val
*/
public function setPreference($key, $val)
{
Expand Down

0 comments on commit 5262fee

Please sign in to comment.