Skip to content

Commit

Permalink
Add initial API docs. Much more to do. Help wanted.
Browse files Browse the repository at this point in the history
  • Loading branch information
massgov-outsider committed Aug 25, 2009
1 parent 14c7daf commit 0b57780
Showing 1 changed file with 60 additions and 0 deletions.
60 changes: 60 additions & 0 deletions drush.api.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
<?php
// $Id$

/**
* @file
* Documentation for Drush.
*/

/**
* @addtogroup hooks
* @{
*/

/**
* Take action before any command is run. Logging an error stops command execution.
*/
function hook_drush_init() {

}

/**
* Run before a specific command executes.
*
* Logging an error stops command execution, and the rollback function (if any)
* for each hook implementation is invoked - hook_COMMAND_validate_rollback().
*/
function hook_COMMAND_validate() {

}

/**
* Run before a specific command executes. Logging an error stops command execution.
*
* Logging an error stops command execution, and the rollback function (if any)
* for each hook implementation is invoked - hook_pre_COMMAND_rollback().
*/
function hook_pre_COMMAND() {

}

/**
* Run after a specific command executes. Logging an error stops command execution.
*
* Logging an error stops command execution, and the rollback function (if any)
* for each hook implementation is invoked - hook_post_COMMAND_rollback().
*/
function hook_post_COMMAND() {

}

/**
* Take action after any command is run.
*/
function hook_drush_exit() {

}

/**
* @} End of "addtogroup hooks".
*/

0 comments on commit 0b57780

Please sign in to comment.