diff --git js_example/js_example.module js_example/js_example.module
index a9f2f82..e590355 100755
--- js_example/js_example.module
+++ js_example/js_example.module
@@ -2,7 +2,19 @@
// $Id: js_example.module,v 1.3 2010/08/11 23:16:27 rfay Exp $
/**
- * Implementation hook_theme().
+ * @file
+ * Module file for js_example.
+ */
+
+/**
+ * @defgroup js_example Example: JavaScript
+ * @ingroup examples
+ * @{
+ * Examples using Drupal 7's built-in JavaScript.
+ */
+
+/**
+ * Implements hook_theme().
*/
function js_example_theme() {
return array(
@@ -31,7 +43,9 @@ function js_example_menu() {
return $items;
}
-
+/**
+ * js_example_weights implementation.
+ */
function js_example_js_weights() {
// add some css to show which line is output by which script
drupal_add_css(drupal_get_path('module', 'js_example') .'/css/jsweights.css');
@@ -55,6 +69,9 @@ function js_example_js_weights() {
return $output;
}
+/**
+ * js_example_accordion implementation.
+ */
function js_example_accordion() {
$title = t('Click sections to expand or collapse:');
$build['myelement'] = array(
diff --git menu_example/menu_example.module menu_example/menu_example.module
index 8b939c3..ea9fca5 100644
--- menu_example/menu_example.module
+++ menu_example/menu_example.module
@@ -3,8 +3,18 @@
/**
* @file
- * Demonstrates uses of the Menu APIs in Drupal, including hook_menu(),
- * hook_menu_alter(), and hook_menu_link_alter().
+ * Module file for menu_example.
+ */
+
+/**
+ * @defgroup menu_example Example: Menu
+ * @ingroup examples
+ * @{
+ * Demonstrates uses of the Menu APIs in Drupal.
+ *
+ * @see hook_menu()
+ * @see hook_menu_alter()
+ * @see hook_menu_link_alter()
*/
/**
@@ -465,4 +475,8 @@ function menu_example_arg_optional_load($id) {
function menu_example_arg_optional_to_arg($arg) {
// If our argument is not provided, give a default of 99.
return (empty($arg) || $arg == '%') ? 99 : $arg;
-}
\ No newline at end of file
+}
+
+/**
+ * @} End of "defgroup menu_example".
+ */
\ No newline at end of file
diff --git node_example/node_example.install node_example/node_example.install
index f7b9b67..8316038 100755
--- node_example/node_example.install
+++ node_example/node_example.install
@@ -18,6 +18,11 @@
/**
* Implements hook_install().
*
+ * This hook is called when the user enables the module for the first time
+ * (or on subsequent enables after the module has been uninstalled). So it's
+ * a good place to define our new module type.
+ *
+ * We will:
* - Add the body field.
* - Configure the body field.
* - Create color, quantity, and image fields.
@@ -28,16 +33,23 @@
* @see field_update_instance()
* @see field_create_field()
* @see field_create_instance()
+ * @ingroup node_example
*/
function node_example_install() {
- // use get_t() to get the name of our localization function for translation
- // during install, when t() is not available.
+ // During installation, the t() function is unavailable. So we use get_t()
+ // to store the name of the translation function.
$t = get_t();
- // Define the node type.
+ // We define the node type as an associative array.
$node_example = array(
'type' => 'node_example',
'name' => $t('Example Node'),
+ // 'base' tells Drupal the base string for hook functions.
+ // This is often the module name, so if base is set to
+ // 'mymodule', Drupal would call mymodule_insert or similar
+ // for node hooks.
+ // In this case, we say 'node_content' so Drupal will handle
+ // our node as if we had designed it in the UI.
'base' => 'node_content',
'description' => $t('This is an example node type with a few fields.'),
'body_label' => $t('Example Description')
@@ -84,10 +96,66 @@ function node_example_install() {
}
/**
- * Return a structured array defining the fields created by this content type.
+ * Implements hook_uninstall().
+ *
+ * This hook is called when the user not only has disabled the module,
+ * but also uninstalls it from the 'uninstall' tab in the module page.
+ *
+ * So it's a perfect time to remove our fields and instances and new
+ * node type from the database.
+ *
+ * @ingroup node_example
+ */
+function node_example_uninstall() {
+ // Gather all the example content that might have been created while this
+ // module was enabled. Simple selects still use db_query().
+ // http://api.drupal.org/api/function/db_query/7
+ $sql = 'SELECT nid FROM {node} n WHERE n.type = :type';
+ $result = db_query($sql, array(':type' => 'node_example'));
+ $nids = array();
+ foreach ($result as $row) {
+ $nids[] = $row->nid;
+ }
+
+ // Delete all the nodes at once
+ // http://api.drupal.org/api/function/node_delete_multiple/7
+ node_delete_multiple($nids);
+
+ // Loop over each of the fields defined by this module and delete
+ // all instances of the field, their data, and the field itself.
+ // http://api.drupal.org/api/function/field_delete_field/7
+ foreach (array_keys(_node_example_installed_fields()) as $field) {
+ field_delete_field($field);
+ }
+
+ // Loop over any remaining field instances attached to the node_example
+ // content type (such as the body field) and delete them individually.
+ // http://api.drupal.org/api/function/field_delete_field/7
+ $instances = field_info_instances('node', 'node_example');
+ foreach ($instances as $instance_name => $instance) {
+ field_delete_instance($instance);
+ }
+
+ // Delete our content type
+ // http://api.drupal.org/api/function/node_type_delete/7
+ node_type_delete('node_example');
+
+ // Purge all field infromation
+ // http://api.drupal.org/api/function/field_purge_batch/7
+ field_purge_batch(1000);
+}
+
+/**
+ * Return an array defining the fields for this content type.
*
- * This is packaged in a function so it can be used in both
+ * This is factored into this function so it can be used in both
* node_example_install() and node_example_uninstall().
+ *
+ * @return
+ * An associative array specifying the fields we wish to add to our
+ * new node type.
+ *
+ * @ingroup node_example
*/
function _node_example_installed_fields() {
$t = get_t();
@@ -114,7 +182,7 @@ function _node_example_installed_fields() {
}
/**
- * Return a structured array defining the instances for this content type.
+ * Return an array defining the instances for this content type.
*
* The instance lets Drupal know which widget to use to allow the user to enter
* data and how to react in different view modes. We are going to display a
@@ -122,8 +190,14 @@ function _node_example_installed_fields() {
* cardinality of three allowing our content type to give the user three color
* fields.
*
- * This is provided as a function so that it can be used in both hook_install()
- * and hook_uninstall().
+ * This is factored into this function so it can be used in both
+ * node_example_install() and node_example_uninstall().
+ *
+ * @return
+ * An associative array specifying the instances we wish to add to our new
+ * node type.
+ *
+ * @ingroup node_example
*/
function _node_example_installed_instances() {
$t = get_t();
@@ -172,47 +246,3 @@ function _node_example_installed_instances() {
),
);
}
-
-
-/**
- * Implements hook_uninstall().
- *
- */
-function node_example_uninstall() {
- // Gather all the example content that might have been created while this
- // module was enabled. Simple selects still use db_query().
- // http://api.drupal.org/api/function/db_query/7
- $sql = 'SELECT nid FROM {node} n WHERE n.type = :type';
- $result = db_query($sql, array(':type' => 'node_example'));
- $nids = array();
- foreach ($result as $row) {
- $nids[] = $row->nid;
- }
-
- // Delete all the nodes at once
- // http://api.drupal.org/api/function/node_delete_multiple/7
- node_delete_multiple($nids);
-
- // Loop over each of the fields defined by this module and delete
- // all instances of the field, their data, and the field itself.
- // http://api.drupal.org/api/function/field_delete_field/7
- foreach (array_keys(_node_example_installed_fields()) as $field) {
- field_delete_field($field);
- }
-
- // Loop over any remaining field instances attached to the node_example
- // content type (such as the body field) and delete them individually.
- // http://api.drupal.org/api/function/field_delete_field/7
- $instances = field_info_instances('node', 'node_example');
- foreach ($instances as $instance_name => $instance) {
- field_delete_instance($instance);
- }
-
- // Delete our content type
- // http://api.drupal.org/api/function/node_type_delete/7
- node_type_delete('node_example');
-
- // Purge all field infromation
- // http://api.drupal.org/api/function/field_purge_batch/7
- field_purge_batch(1000);
-}
diff --git node_example/node_example.module node_example/node_example.module
index e6563bb..bdbda07 100755
--- node_example/node_example.module
+++ node_example/node_example.module
@@ -3,35 +3,48 @@
/**
* @file
- * This is an example outlining how a module can be used to define a new
- * node type. In Drupal 7 we move most of what was once needed in this file
- * to the node_example.install file so that it can be managed efficiently.
- *
- * Our example node type will allow users to specify multiple "colors",
- * a "quantity" and an "image" for their nodes; some kind of rudimentary
- * inventory-tracking system, perhaps?
- *
- * In previous versions of Drupal, "teaser" and "page" were node view modes. In
- * Drupal 7 we can define custom view modes to let the node know how it should
- * return it's data. This module declares a custom view mode called
- * "example_node_list".
- *
- * We no longer need an extra database table to store this content type's
- * information.
- *
- * Most node types that provide fields do not require any custom code for
- * the fields, as the fields system provides storage and access.
- *
- * See @link http://drupal.org/node/707832 Field API Tutorial @endlink
+ * Module file for Node Example module.
*
- * See @link http://drupal.org/node/443536 Field API Handbook Page @endlink
+ * Part of the Examples for Developers project.
+ */
+
+/**
+ * @defgroup node_example Example: Node
+ * @ingroup examples
+ * @{
+ * Example defining a node type in code.
*
- * See @link field Field API documentation @endlink
+ * This is an example outlining how a module can be used to define a new
+ * node type. Our example node type will allow users to specify multiple
+ * "colors", a "quantity" and an "image" for their nodes; some kind of
+ * rudimentary inventory-tracking system, perhaps?
*
- * See @link field_example.install field_example.install @endlink
+ * The basic pattern for defining a node type is to tell Drupal about the
+ * node's field types, and view modes. Drupal will then take over and manage
+ * the storage for this node type. This differs from Drupal 6, where we
+ * would have to handle all the database storage ourselves in the module.
*
* Remember that most node types do not require any custom code, as one
- * simply creates them using the fields UI.
+ * simply creates them using the Drupal user interface. Creating a node like
+ * this in code is a special case.
+ *
+ * Drupal 7 has us defining most of our node structure in arrays,
+ * and passing those to node_type_save(). We use hook_install() as
+ * a convenient place to define these types, and hook_uninstall()
+ * as a convenient place to not only uninstall the data contained
+ * in these nodes, but also remove the node types from Drupal's
+ * knowledge. This means that most of the code to define a new node type
+ * would be in the module's .install file.
+ *
+ * In previous versions of Drupal, "teaser" and "page" were node view modes.
+ * In Drupal 7 we can define custom view modes to let the node know how it
+ * should return it's data. This module declares a custom view mode called
+ * "example_node_list".
+ *
+ * @see @link http://drupal.org/node/707832 Field API Tutorial @endlink
+ * @see @link http://drupal.org/node/443536 Field API Handbook Page @endlink
+ * @see @link field Field API documentation @endlink
+ * @see field_example.module
*/
@@ -56,6 +69,8 @@ function node_example_menu() {
* @return
* a build array
*
+ * @see node_load
+ * @see node_view
*/
function node_example_page() {
$build = array();
@@ -69,8 +84,6 @@ function node_example_page() {
// Loop through each of our node_example nodes and instruct node_view
// to use our custom "example_node_list" view.
- // http://api.drupal.org/api/function/node_load/7
- // http://api.drupal.org/api/function/node_view/7
foreach ($result as $row) {
$node = node_load($row->nid);
$build['node_list'][]= node_view($node, 'example_node_list');
@@ -166,3 +179,7 @@ function theme_example_node_color($variables) {
$output = '
' . $variables['color'] . '';
return $output;
}
+
+/**
+ * @} End of "defgroup node_example".
+ */
\ No newline at end of file
diff --git page_example/page_example.module page_example/page_example.module
index 2577a59..bab062c 100755
--- page_example/page_example.module
+++ page_example/page_example.module
@@ -3,6 +3,13 @@
/**
* @file
+ * Module file for page_example_module.
+ */
+
+/**
+ * @defgroup page_example Example: Page
+ * @ingroup examples
+ * @{
* This is an example outlining how a module can be used to display a
* custom page at a given URL.
*/
@@ -117,9 +124,14 @@ function page_example_menu() {
return $items;
}
+/**
+ * page_example_description function.
+ *
+ */
function page_example_description() {
return array('#markup' => t('The page_example provides two pages, "simple" and "arguments". The
simple page just returns a renderable array for display. The
arguments page takes two arguments and displays them, as in @arguments_link', array('@simple_link' => url('examples/page_example/simple', array('absolute' => TRUE)), '@arguments_link' => url('examples/page_example/arguments/23/56', array('absolute' => TRUE)))));
}
+
/**
* A simple page callback.
*
@@ -166,3 +178,6 @@ function page_example_arguments($first, $second) {
);
return $render_array;
}
+/**
+ * @} End of "defgroup page_example".
+ */
\ No newline at end of file
diff --git queue_example/queue_example.module queue_example/queue_example.module
index 307d46d..c2cbe05 100644
--- queue_example/queue_example.module
+++ queue_example/queue_example.module
@@ -4,6 +4,13 @@
/**
* @file
* Examples demonstrating the Drupal Queue API.
+ */
+
+/**
+ * @defgroup queue_example Example: Queue
+ * @ingroup examples
+ * @{
+ * Demonstrating the Queue API
*
* The Queue API provides a traditional FIFO (first-in-first-out) queue,
* but also provides the concepts of:
@@ -273,4 +280,7 @@ function queue_example_theme() {
'variables' => array('items' => NULL),
),
);
-}
\ No newline at end of file
+}
+/**
+ * @} End of "defgroup queue_example".
+ */
\ No newline at end of file
diff --git render_example/render_example.module render_example/render_example.module
index b9f1b73..0dd8c73 100644
--- render_example/render_example.module
+++ render_example/render_example.module
@@ -1,8 +1,17 @@
';
return $output;
-}
\ No newline at end of file
+}
+/**
+ * @} End of "defgroup render_example".
+ */
\ No newline at end of file
diff --git simpletest_example/simpletest_example.module simpletest_example/simpletest_example.module
index c3259e5..b639793 100644
--- simpletest_example/simpletest_example.module
+++ simpletest_example/simpletest_example.module
@@ -3,6 +3,13 @@
/**
* @file
+ * Module file for simpletest_example
+ */
+
+/**
+ * @defgroup simpletest_example Example: Simpletest
+ * @ingroup examples
+ * @{
* An example of simpletest tests to accompany the tutorial at
* http://drupal.org/node/890654.
*
@@ -10,7 +17,6 @@
*
*/
-
/**
* Implements hook_node_info().
*/
@@ -111,3 +117,6 @@ function _simpletest_example_explanation() {
return $explanation;
}
+/**
+ * @} End of "defgroup simpletest_example".
+ */
\ No newline at end of file
diff --git token_example/token_example.module token_example/token_example.module
index 02ca66a..e1a3e09 100644
--- token_example/token_example.module
+++ token_example/token_example.module
@@ -2,6 +2,29 @@
// $Id: token_example.module,v 1.8 2010/07/19 02:10:57 davereid Exp $
/**
+ * @file
+ * The Token API module.
+ *
+ * The Token module provides an API for providing tokens to other modules.
+ * Tokens are small bits of text that can be placed into larger documents
+ * via simple placeholders, like %site-name or [user].
+ */
+
+/**
+ * @defgroup token_example Example: Token API
+ * @ingroup examples
+ * @{
+ * Examples using the Token API.
+ *
+ * The Token module provides an API for providing tokens to other modules.
+ * Tokens are small bits of text that can be placed into larger documents
+ * via simple placeholders, like %site-name or [user].
+ *
+ * This example is part of the Examples for Developers Project which you can download
+ * and experiment with here: http://drupal.org/project/examples
+ */
+
+/**
* Implements hook_menu().
*/
function token_example_menu() {
@@ -194,3 +217,7 @@ function _token_example_get_file() {
$files = array_map('check_plain', $files);
return $files;
}
+
+/**
+ * @} End of "defgroup token_example".
+ */
\ No newline at end of file
diff --git token_example/token_example.tokens.inc token_example/token_example.tokens.inc
index 2696cf7..968bb1d 100644
--- token_example/token_example.tokens.inc
+++ token_example/token_example.tokens.inc
@@ -8,6 +8,8 @@
/**
* Implements hook_token_info().
+ *
+ * @ingroup token_example
*/
function token_example_token_info() {
// Add two different token types. The first is the generic text format. The
@@ -55,6 +57,8 @@ function token_example_token_info() {
/**
* Implements hook_tokens().
+ *
+ * @ingroup token_example
*/
function token_example_tokens($type, $tokens, array $data = array(), array $options = array()) {
$replacements = array();
diff --git trigger_example/trigger_example.module trigger_example/trigger_example.module
index 223d991..6043649 100644
--- trigger_example/trigger_example.module
+++ trigger_example/trigger_example.module
@@ -4,6 +4,14 @@
/**
* @file
* Trigger definition example module.
+ */
+
+/**
+ * @defgroup trigger_example Example: Trigger
+ * @ingroup examples
+ * @{
+ *
+ * Trigger definition example module.
*
* Triggers and actions are a pair of special-purpose functions allowing some
* Drupal programming without using PHP. Using the
diff --git vertical_tabs_example/vertical_tabs_example.js vertical_tabs_example/vertical_tabs_example.js
index bca0b71..31b00a6 100644
--- vertical_tabs_example/vertical_tabs_example.js
+++ vertical_tabs_example/vertical_tabs_example.js
@@ -3,7 +3,9 @@
(function ($) {
/**
- * Custom summary for the module vertical tab.
+ * Custom summary for the module vertical tab. (JavaScript)
+ *
+ * @ingroup veritcal_tabs_example
*/
Drupal.behaviors.vertical_tabs_exampleFieldsetSummaries = {
attach: function (context) {
diff --git vertical_tabs_example/vertical_tabs_example.module vertical_tabs_example/vertical_tabs_example.module
index a47219c..7b90a80 100644
--- vertical_tabs_example/vertical_tabs_example.module
+++ vertical_tabs_example/vertical_tabs_example.module
@@ -3,9 +3,19 @@
/**
* @file
- * Shows how to use the vertical tabs functionality provided by Drupal 7. This
- * example does not cover how to save / load custom setting, and only deals with
- * elements visibility.
+ * Module file for vertical_tabs_example module.
+ */
+
+/**
+ * @defgroup vertical_tabs_example Example: Vertical Tabs
+ * @ingroup examples
+ * @{
+ * Demonstrates the vertical tabs functionality provided by Drupal 7.
+ *
+ * This example does not cover how to save / load custom setting, and only
+ * deals with elements visibility.
+ *
+ * @see vertical_tabs_example.js
*/
/**
@@ -88,3 +98,7 @@ function vertical_tabs_example_form_alter(&$form, $form_state, $form_id) {
function _vertical_tabs_example_explanation() {
return t("The Vertical Tabs Example shows how a custom module can best support vertical tabs. To see the effects of this module, look at the
node/add form", array('!node_add' => url('node/add')));
}
+
+/**
+ * @} End of "defgroup vertical_tabs_example".
+ */
\ No newline at end of file
diff --git xmlrpc_example/xmlrpc_example.module xmlrpc_example/xmlrpc_example.module
index 044f7e3..2a317fe 100644
--- xmlrpc_example/xmlrpc_example.module
+++ xmlrpc_example/xmlrpc_example.module
@@ -3,6 +3,15 @@
/**
* @file
+ * Module file for xmlrpc_example module.
+ */
+
+/**
+ * @defgroup xmlrpc_example Example: XML-RPC
+ * @ingroup examples
+ * @{
+ * Demonstration of XML-RPC in Drupal 7.
+ *
* This is an example of how to implement and XML-RPC server by registering
* callbacks to specific methods and how to make xmlrpc calls using the built-in
* xmlrpc() factory provided by Drupal.
@@ -646,3 +655,7 @@ function xmlrpc_example_alter_form() {
}
// The alteration part of the module ends here.
+
+/**
+ * @} End of "defgroup xmlrpc_example".
+ */
\ No newline at end of file