I am working on implementing PHPCS in my build scripts and with relative ease I resolve all ERRORS and WARNINGS (and a little help from SO :)).
However, I cannot understand why I am still receiving an ERROR message that the class is missing comments on files, classes, and functions.
FOUND 7 ERRORS AFFECTING 7 LINES
2 | ERROR | Missing file doc comment
28 | ERROR | Missing class doc comment
45 | ERROR | Missing function doc comment
59 | ERROR | Missing function doc comment
73 | ERROR | Missing function doc comment
88 | ERROR | Missing function doc comment
102 | ERROR | Missing function doc comment
Here is the PHP class:
<Preview> <code> <? PHP / ** * Comment file EndpointHelper * * @category EndpointHelper * @package Helper * @author Brian Smith < brian.smith@company.com > * @copyright Copyright 2015 Company, Inc. All rights reserved. * @license GNU General Public License version 2 or later; see LICENSE * @link http://arctg.com * / / ** * Comment on EndpointHelper doctor * * Endpoint Assistant for a wide range of applications * URLs based on an active web server. * * @category Class * @package EndpointHelper * @author Brian Smith < brian.smith@company.com> * @copyright Copyright 2015 Company, Inc. All rights reserved. * @license GNU General Public License version 2 or later; see LICENSE * @link http://company.com * * @since 1.0.1 * / EndpointHelper class {/ ** * Component params object * * @var type * @since 1.0.1 * / private static $ params = false / ** * Get web-based reservation URL * * @return String * * @since 1.0.1 * / public static function getReservationUrl () {$ instance = self :: getInstanceType (); return self :: $ params-> get ($ instance. '_reservation_api_url'); } / ** * Get the rental URL based on the web instance * * @return String * * @since 1.0.1 * / public static function getRentalUrl () {$ instance = self :: getInstanceType (); return self ::$ params-> get ($ instance. '_rental_api_url'); } / ** * Get the cache URL based on the web instance * * @return String * * @since 1.0.1 * / public static function getCacheUrl () {$ instance = self :: getInstanceType (); return self :: $ params-> get ($ instance. '_data_cache_api_url'); } / ** * Getting system files Synchronizing a URL based on a web page * example. * * @return String * * @since 1.0.1 * / public static function getFileSyncUrl () {$ instance = self :: getInstanceType (); return self :: $ params-> get ($ instance. '_file_sync'); } / ** * A private utility class to retrieve the current web instance * * @return String * * @since 1.0.1 * / private static function getInstanceType () {if (! Self :: $ params) {self :: $ params = JComponentHelper :: getParams ('com_custom'); } return self :: $ params-> get ('web_instance'); }} Code>!