From 0b577806120a58d22783771e557838727d6427eb Mon Sep 17 00:00:00 2001
From: moshe weitzman <weitzman@cyrve.com>
Date: Tue, 25 Aug 2009 17:45:32 +0000
Subject: [PATCH] Add initial API docs. Much more to do. Help wanted.

---
 drush.api.php | 60 +++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 60 insertions(+)
 create mode 100644 drush.api.php

diff --git a/drush.api.php b/drush.api.php
new file mode 100644
index 0000000000..4a126e130e
--- /dev/null
+++ b/drush.api.php
@@ -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".
+ */