#314870 by Rob Loach, drewish, catch, and sun: Add hook API documentation to Drupal core.

1 files changed, 29 insertions, 0 deletions

diff --git a/modules/locale/locale.api.php b/modules/locale/locale.api.php
new file mode 100644
index 000000000..60ad3b7f1
--- /dev/null
+++ b/modules/locale/locale.api.php
@@ -0,0 +1,29 @@
+<?php
+// $Id$
+
+/**
+ * @file
+ * Hooks provided by the Locale module.
+ */
+
+/**
+ * @addtogroup hooks
+ * @{
+ */
+
+/**
+ * Allows modules to define their own text groups that can be translated.
+ *
+ * @param $op
+ *   Type of operation. Currently, only supports 'groups'.
+ */
+function hook_locale($op = 'groups') {
+  switch ($op) {
+    case 'groups':
+      return array('custom' => t('Custom'));
+  }
+}
+
+/**
+ * @} End of "addtogroup hooks".
+ */