Add docs to class headers

This commit is contained in:
Sam Georges 2014-10-03 18:00:21 +10:00
parent fee5925246
commit 8d73924fbb
11 changed files with 54 additions and 0 deletions

View File

@ -5,6 +5,9 @@ use Request;
/**
* Model for logging access to the back-end
*
* @package october\backend
* @author Alexey Bobkov, Samuel Georges
*/
class AccessLog extends Model
{

View File

@ -6,6 +6,12 @@ use Model;
use Session;
use DirectoryIterator;
/**
* Backend preferences for the backend user
*
* @package october\backend
* @author Alexey Bobkov, Samuel Georges
*/
class BackendPreferences extends Model
{
public $implement = ['Backend.Behaviors.UserPreferencesModel'];

View File

@ -4,6 +4,12 @@ use App;
use Model;
use DirectoryIterator;
/**
* Code editor preferences for the backend user\
*
* @package october\backend
* @author Alexey Bobkov, Samuel Georges
*/
class EditorPreferences extends Model
{
public $implement = ['Backend.Behaviors.UserPreferencesModel'];

View File

@ -6,6 +6,12 @@ use October\Rain\Database\Model;
use System\Classes\SystemException;
use October\Rain\Auth\Models\Preferences as PreferencesBase;
/**
* All preferences for the backend user
*
* @package october\backend
* @author Alexey Bobkov, Samuel Georges
*/
class UserPreferences extends PreferencesBase
{
/**

View File

@ -5,6 +5,9 @@ use Model;
/**
* Model for logging system errors and debug trace messages
*
* @package october\system
* @author Alexey Bobkov, Samuel Georges
*/
class EventLog extends Model
{

View File

@ -3,6 +3,12 @@
use Model;
use System\Classes\ApplicationException;
/**
* Mail layout
*
* @package october\system
* @author Alexey Bobkov, Samuel Georges
*/
class MailLayout extends Model
{
use \October\Rain\Database\Traits\Validation;

View File

@ -3,6 +3,12 @@
use App;
use Model;
/**
* Mail settings
*
* @package october\system
* @author Alexey Bobkov, Samuel Georges
*/
class MailSettings extends Model
{
public $implement = ['System.Behaviors.SettingsModel'];

View File

@ -7,6 +7,12 @@ use Model;
use October\Rain\Mail\MailParser;
use System\Classes\PluginManager;
/**
* Mail template
*
* @package october\system
* @author Alexey Bobkov, Samuel Georges
*/
class MailTemplate extends Model
{
use \October\Rain\Database\Traits\Validation;

View File

@ -6,6 +6,9 @@ use October\Rain\Database\Model;
/**
* Parameters model
* Used for storing internal application parameters.
*
* @package october\system
* @author Alexey Bobkov, Samuel Georges
*/
class Parameters extends Model
{

View File

@ -5,6 +5,12 @@ use Model;
use Config;
use System\Classes\PluginManager;
/**
* Stores information about current plugin versions.
*
* @package october\system
* @author Alexey Bobkov, Samuel Georges
*/
class PluginVersion extends Model
{
use \October\Rain\Database\Traits\Purgeable;

View File

@ -5,6 +5,9 @@ use Request;
/**
* Model for logging 404 errors
*
* @package october\system
* @author Alexey Bobkov, Samuel Georges
*/
class RequestLog extends Model
{