From 1a4cd29203ab2020b89d89991eed23bdd798d401 Mon Sep 17 00:00:00 2001
From: Stanislas Dolcini <stanislas.dolcini@devinci.fr>
Date: Sat, 6 Oct 2018 14:34:51 +0200
Subject: [PATCH] Add doxygen comments for the nel message class

---
 .../public_php/login/class/nel_command.php    | 25 +++++++++++++++++++
 1 file changed, 25 insertions(+)

diff --git a/code/web/public_php/login/class/nel_command.php b/code/web/public_php/login/class/nel_command.php
index 1641ee149..533d53d74 100644
--- a/code/web/public_php/login/class/nel_command.php
+++ b/code/web/public_php/login/class/nel_command.php
@@ -1,11 +1,36 @@
 <?php
+/**
+ * Defines a standard get command sent by the user
+ * to login to the server.
+ * @todo Add an email field.
+ */
 class NelCommand
 {
+    /**
+     * The command to be executed.
+     * Currently, 'ask', 'login', and 'login-https' are supported.
+     */
     public $cmd;
+    /**
+     * The user's login.
+     */
     public $login;
+    /**
+     * The password.
+     */
     public $password;
+    /**
+     * The user's domain.
+     * @todo make sure of its usage.
+     */
     public $clientApplication;
+    /**
+     * Whether to clear the password or not.
+     */
     public $cp;
+    /**
+     * The user's language.
+     */
     public $submittedLang;
 
     public function __construct($getParams)