Cleaned up code

Author: lachiebol

Annotations/AnnotationGenerator.php

@@ -122,7 +122,7 @@ public function generatePluginApiAnnotations(string $pluginName, bool $writeToFi
         $pluginMetadata = Proxy::getInstance()->getMetadata()[$className] ?? [];
 
         $annotations = [[sprintf('@OA\Tag(name="%s")', $pluginName)]];
-//      I decided to not include the description in the tag annotation so that it automatically pulls the API class comment as the description.
+
         if (!empty($pluginMetadata['__documentation'])) {
             $tagLines = $this->buildLinesForAnnotationObject('@OA\Tag', [
                 sprintf('name="%s"', $pluginName),
@@ -1772,6 +1772,7 @@ public function buildSchemaObjectArrays(array $typesMap, string $default = '', s
      * @param string $plugin The name of the plugin. E.g. CustomReports
      * @param array $params The compiled list of method parameters and key information about them, like type.
      * @param array $responses compiled list of method expected responses and key information about them, like type.
+     * @param string $description The method level description
      * @param bool $isPost Indicates whether the operation is a POST. The default is false, meaning it's GET.
      *
      * @return string[] The array of all the lines of the operation annotation object.

Specs/SpecGenerator.php

@@ -72,8 +72,6 @@ public function generateSpec(array $pluginNames, string $format = 'json', string
             BaseValidator::check('pluginName', $pluginName, [new NotEmpty()]);
             Manager::getInstance()->checkIsPluginActivated($pluginName);
 
-            $pluginDir = Manager::getInstance()::getPluginDirectory($pluginName);
-//            $pluginAnnotationsSource = $pluginDir . '/API.php';
             $pluginAnnotationsSource = $currentPluginDir . '/tmp/annotations/' . $pluginName . 'GeneratedAnnotations.php';
             try {
                 $openapi = (new Generator(StaticContainer::get(NullLogger::class)))->generate([
@@ -82,9 +80,9 @@ public function generateSpec(array $pluginNames, string $format = 'json', string
             } catch (\Throwable $e) {
                 throw new \Exception('There was an error testing the API annotations for plugin ' . $pluginName, 0, $e);
             }
-//            if (trim($openapi->toYaml()) === 'openapi: ' . OpenApi::DEFAULT_VERSION) {
-//                throw new \Exception("The $pluginName plugin's API class does not appear to be annotated yet.");
-//            }
+            if (trim($openapi->toYaml()) === 'openapi: ' . OpenApi::DEFAULT_VERSION) {
+                throw new \Exception("The $pluginName plugin's API class does not appear to be annotated yet.");
+            }
             $pluginDirs[$pluginName] = $pluginAnnotationsSource;
         }