Add doxygen comments for the nel message class
This commit is contained in:
parent
46530408f2
commit
1a4cd29203
1 changed files with 25 additions and 0 deletions
|
@ -1,11 +1,36 @@
|
||||||
<?php
|
<?php
|
||||||
|
/**
|
||||||
|
* Defines a standard get command sent by the user
|
||||||
|
* to login to the server.
|
||||||
|
* @todo Add an email field.
|
||||||
|
*/
|
||||||
class NelCommand
|
class NelCommand
|
||||||
{
|
{
|
||||||
|
/**
|
||||||
|
* The command to be executed.
|
||||||
|
* Currently, 'ask', 'login', and 'login-https' are supported.
|
||||||
|
*/
|
||||||
public $cmd;
|
public $cmd;
|
||||||
|
/**
|
||||||
|
* The user's login.
|
||||||
|
*/
|
||||||
public $login;
|
public $login;
|
||||||
|
/**
|
||||||
|
* The password.
|
||||||
|
*/
|
||||||
public $password;
|
public $password;
|
||||||
|
/**
|
||||||
|
* The user's domain.
|
||||||
|
* @todo make sure of its usage.
|
||||||
|
*/
|
||||||
public $clientApplication;
|
public $clientApplication;
|
||||||
|
/**
|
||||||
|
* Whether to clear the password or not.
|
||||||
|
*/
|
||||||
public $cp;
|
public $cp;
|
||||||
|
/**
|
||||||
|
* The user's language.
|
||||||
|
*/
|
||||||
public $submittedLang;
|
public $submittedLang;
|
||||||
|
|
||||||
public function __construct($getParams)
|
public function __construct($getParams)
|
||||||
|
|
Loading…
Reference in a new issue