Missing function/class method doc comment PHP-D1002
Documentation
Minor
a month ago
—
a year old
Doc comment missing for function
flux_display_empty_emblem 9 }
10}
11
12function flux_display_empty_emblem()13{
14 $data = flux_get_default_bmp_data();
15 header("Content-Type: image/bmp");Doc comment missing for function
flux_get_default_bmp_data 1<?php
2if (!defined('FLUX_ROOT')) exit;
3
4function flux_get_default_bmp_data() 5{
6 $filename = sprintf('%s/emblem/%s', FLUX_DATA_DIR, Flux::config('MissingEmblemBMP'));
7 if (file_exists($filename)) {Doc comment missing for class method
step156 return ($status);
157 }
158
159 public function step(&$client, $response, &$message, &$interactions)160 {
161 switch ($this->state) {
162 case SASL_NTLM_STATE_IDENTIFY_DOMAIN:Doc comment missing for class method
start135 );
136 }
137
138 public function start(&$client, &$message, &$interactions)139 {
140 if ($this->state != SASL_NTLM_STATE_START) {
141 $client->error = "NTLM authentication state is not at the start";Doc comment missing for class method
typeMsg3 85 return $response;
86 }
87
88 public function typeMsg3($ntlm_response, $user, $domain, $workstation) 89 {
90 $domain_unicode = $this->ASCIIToUnicode($domain);
91 $domain_length = strlen($domain_unicode);
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 function/class method is missing the doc comment and it is recommended to add it for the reasons discussed above.