generateDocumentation() public method

Generate a documentation skeleton for the package key
public generateDocumentation ( string $packageKey ) : array
$packageKey string The package key
return array An array of generated filenames
GeneratorService Class Documentation
Example #1
0
 /**
  * Kickstart documentation
  *
  * Generates a documentation skeleton for the given package.
  *
  * @param string $packageKey The package key of the package for the documentation
  * @return string
  */
 public function documentationCommand($packageKey)
 {
     $this->validatePackageKey($packageKey);
     if (!$this->packageManager->isPackageAvailable($packageKey)) {
         $this->outputLine('Package "%s" is not available.', array($packageKey));
         exit(2);
     }
     $generatedFiles = $this->generatorService->generateDocumentation($packageKey);
     $this->outputLine(implode(PHP_EOL, $generatedFiles));
 }