Missing class doc comment PHP-D1001
Documentation
Minor
a month ago
—
a year old
Doc comment missing for class
ntlm_sasl_client_class 13define("SASL_FAIL", -1);
14define("SASL_CONTINUE", 1);
15
16class ntlm_sasl_client_class 17{
18 public $credentials = array();
19 public $state = SASL_NTLM_STATE_START;Doc comment missing for class
Flux_RegisterError 1<?php
2require_once 'Flux/Error.php';
3
4class Flux_RegisterError extends Flux_Error { 5 const USERNAME_ALREADY_TAKEN = 0;
6 const USERNAME_TOO_SHORT = 1;
7 const USERNAME_TOO_LONG = 2;Doc comment missing for class
Flux_PermissionError1<?php
2require_once 'Flux/Error.php';
3
4class Flux_PermissionError extends Flux_Error {5
6}
7?>Doc comment missing for class
Flux_Mailer 2require 'phpmailer/PHPMailerAutoload.php';
3require_once 'Flux/LogFile.php';
4
5class Flux_Mailer { 6 protected $pm;
7 protected static $errLog;
8 protected static $log;Doc comment missing for class
Flux_LoginError 1<?php
2require_once 'Flux/Error.php';
3
4class Flux_LoginError extends Flux_Error { 5 const UNEXPECTED = 0;
6 const INVALID_SERVER = 1;
7 const INVALID_LOGIN = 2;
Description
Documentation comments are helpful in understanding what that part of the code is responsible for. It is always a good idea to add documentation to your code to improve the code readability and maintainability. In addition to that, it becomes helpful when you revisit the code after a long time. Here, the class is missing the doc comment and it is recommended to add it for the reasons discussed above.
If you don't want DeepSource to raise issues for missing doc comments, you can configure it in the .deepsource.toml configuration file. Please refer to the PHP docs for available options.