Skip to content

Add doc comments #12

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Sep 10, 2018
Merged

Add doc comments #12

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
54ea719
Add doc comments
kirtangajjar Sep 7, 2018
e152bb9
Add example with force flag
kirtangajjar Sep 10, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 26 additions & 4 deletions src/Admin_Tools_Command.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,7 @@
* @package ee-cli
*/

use Composer\Console\Application;
use EE\Model\Site;
use Symfony\Component\Console\Input\ArrayInput;
use Symfony\Component\Filesystem\Filesystem;
use function EE\Site\Utils\auto_site_name;

Expand Down Expand Up @@ -41,7 +39,13 @@ public function __construct() {
}

/**
* Installs admin-tools for EasyEngine.
* Installs admin tools for EasyEngine.
*
* ## EXAMPLES
*
* # Install admin tools
* $ ee admin-tools install
*
*/
public function install() {

Expand Down Expand Up @@ -88,7 +92,7 @@ public function install() {
}

/**
* Enables admin-tools on given site.
* Enables admin tools on site.
*
* ## OPTIONS
*
Expand All @@ -97,6 +101,15 @@ public function install() {
*
* [--force]
* : Force enabling of admin-tools for a site.
*
* ## EXAMPLES
*
* # Enable admin tools on site
* $ ee admin-tools up example.com
*
* # Force enable admin tools on site
* $ ee admin-tools up example.com --force
*
*/
public function up( $args, $assoc_args ) {

Expand Down Expand Up @@ -153,6 +166,15 @@ public function up( $args, $assoc_args ) {
*
* [--force]
* : Force disabling of admin-tools for a site.
*
* ## EXAMPLES
*
* # Disable admin tools on site
* $ ee admin-tools down example.com
*
* # Force disable admin tools on site
* $ ee admin-tools down example.com --force
*
*/
public function down( $args, $assoc_args ) {

Expand Down