buildSwagger Class Reference
Inheritance diagram for buildSwagger:
Public Member Functions | |
| __construct ($argv=array()) | |
| execute () | |
| usage () | |
Data Fields | |
| $outputFile | |
| $parameters | |
 Data Fields inherited from CommandLineTool | |
| $argv | |
| $scriptName | |
Detailed Description
CLI tool to compile a complete swagger.json file for hosting API documentation.
Definition at line 19 of file buildSwagger.php.
Constructor & Destructor Documentation
◆ __construct()
| buildSwagger::__construct | ( | $argv = array() | ) |
Constructor.
- Parameters
-
$argv array command-line arguments (see usage)
Reimplemented from CommandLineTool.
Definition at line 28 of file buildSwagger.php.
References CommandLineTool\$argv.
Member Function Documentation
◆ execute()
| buildSwagger::execute | ( | ) |
Parse and execute the import/export task.
Definition at line 46 of file buildSwagger.php.
References PKPServices\get(), and usage().
◆ usage()
| buildSwagger::usage | ( | ) |
Print command usage information.
Reimplemented from CommandLineTool.
Definition at line 36 of file buildSwagger.php.
Referenced by execute().
Field Documentation
◆ $outputFile
| buildSwagger::$outputFile |
Definition at line 21 of file buildSwagger.php.
◆ $parameters
| buildSwagger::$parameters |
Definition at line 22 of file buildSwagger.php.
The documentation for this class was generated from the following file:
