wpdesk / plugin-documentation-creator
There is no license information available for the latest version (1.2.0) of this package.
Plugin documentation
1.2.0
2020-12-30 15:08 UTC
Requires
- php: >=8.0
- m1x0n/helpscout-docs-api-php: ^1.4
- wpdesk/hook-parser: ^1.4
Requires (Dev)
- phpstan/phpstan: ^0.12.59
This package is auto-updated.
Last update: 2024-11-29 06:28:54 UTC
README
Library that helps to create a full plugin documentation.
Usage
<?php
use PluginDocumentationCreator\Creator;
use PluginDocumentationCreator\Sender\HelpScoutSender;
require_once __DIR__ . '/vendor/autoload.php';
$pluginPath = $argv[1];
$apiKey = $argv[2] ?? $_SERVER['HELPSCOUT_API_KEY'];
$hookPageName = $argv[3] ?? $_SERVER['HELPSCOUT_HOOK_PAGE_ID'];
$hookSender = new HelpScoutSender( $apiKey, $hookPageName );
$creator = new Creator( $pluginPath );
$creator->createHooksDocumentation( $hookSender );