diff --git a/action_example/CHANGELOG.txt b/action_example/CHANGELOG.txt deleted file mode 100644 index 8b13789..0000000 --- a/action_example/CHANGELOG.txt +++ /dev/null @@ -1 +0,0 @@ - diff --git a/action_example/action_example.module b/action_example/action_example.module index 20638cd..06ccec6 100644 --- a/action_example/action_example.module +++ b/action_example/action_example.module @@ -3,10 +3,18 @@ /** * @file * Action definition example module. + */ + +/** + * @defgroup action_example Example: Action + * @ingroup examples + * @{ + * Creating actions in Drupal 7 * * Triggers and actions are a matched pair of Drupal features allowing some * Drupal programming without using PHP. Using the appropriate action in a * specific event, a site administrator can add new functionality. + * * Examples are: * - Send an email after a node is published or edited. * - Display a message after a user has logged in. @@ -53,17 +61,10 @@ * - An action which extends the capabilities of node triggers, but limited * to certain events only, and using a customizable option. * - * See: - * - * @todo this is a drupal 6 link - * @link http://drupal.org/node/172152 Writing Actions @endlink - * - * @todo this is a drupal 6 link - * @link http://drupal.org/node/199254 Triggers and Actions in Drupal 7 @endlink - * + * @see trigger_example * @see hook_action_info() - * In addition, the @link trigger_example.module Trigger Example @endlink - * provides detailed information on how to create a trigger. + * @see @link http://drupal.org/node/172152 Writing Actions in Drupal 6 @endlink + * @see @link http://drupal.org/node/199254 Triggers and Actions in Drupal 6 @endlink */ /** @@ -137,7 +138,7 @@ * special care in the "presave" hook, in which case a dependent "save" * action should NOT be invoked. * - * See hook_action_info(). + * @see hook_action_info() */ function action_example_action_info() { return array( @@ -168,7 +169,7 @@ function action_example_action_info() { /** * Implements hook_menu(). * - * Simply provide a menu entry which explains what the module does. + * Provides a menu entry which explains what the module does. */ function action_example_menu() { $items['examples/action_example'] = array( @@ -188,45 +189,37 @@ function _action_example_page() { return t("The Action Example provides three example actions which can be configured on the Actions configuration page and assigned to triggers on the Triggers configuration page.", array('@actions_url' => url('admin/config/system/actions'), '@triggers_url' => url('admin/structure/trigger/node'))); } -/* - * Most basic action. +/** + * Action function for action_example_basic_action. * * This action is not expecting any type of entity object, and can be used with * any trigger type or any event. - */ - -/** - * Basic example action. * * @param $entity * An optional entity object. - * @param array $context + * @param $context * Array with parameters for this action: depends on the trigger. * - * @ingroup actions + * @see action_example_action_info() */ function action_example_basic_action(&$entity, $context = array()) { // // In this case we are ignoring the entity and the context. This case of // action is useful when your action does not depend on the context, and // the function must do something regardless the scope of the trigger. - // Simply announces that the action was executed using a messages. + // Simply announces that the action was executed using a message. drupal_set_message(t('action_example_basic_action fired')); watchdog('action_example', 'action_example_basic_action fired.'); } -// --------------------------------------------------------------------------- -/* - * A complex action for different trigger types. +/** + * Action function for action_example_unblock_user_action. * * This action is expecting an entity object user, node or comment. If none of * the above is provided (because it was not called from an user/node/comment * trigger event, then the action will be taken on the current logged in user. * - */ - -/** * Unblock an user. This action can be fired from different trigger types: * - User trigger: this user will be unblocked. * - Node/Comment trigger: the author of the node or comment will be unblocked. @@ -236,11 +229,9 @@ function action_example_basic_action(&$entity, $context = array()) { * @param $entity * An optional user object (could be a user, or an author if context is * node or comment) - * @param array $context + * @param $context * Array with parameters for this action: depends on the trigger. The context * is not used in this example. - * - * @ingroup actions */ function action_example_unblock_user_action(&$entity, $context = array()) { @@ -262,29 +253,29 @@ function action_example_unblock_user_action(&$entity, $context = array()) { drupal_set_message(t('Unblocked user %name', array('%name' => $account->name))); } -// --------------------------------------------------------------------------- -/* - * A complex action using customization. +/** + * Form function for action_example_node_sticky_action. * - * The next action requires a configuration form to create/configure the action. - * In Drupal these are called 'advanced actions', because they must be - * customized to define their functionality. + * Since we defined action_example_node_sticky_action as 'configurable' => TRUE, + * this action requires a configuration form to create/configure the action. + * In this circumstance, Drupal will attempt to call a function named by + * combining the action name (action_example_node_sticky_action) and _form, in + * this case yielding action_example_node_sticky_action_form. + * + * In Drupal, actions requiring creation and configuration are called 'advanced + * actions', because they must be customized to define their functionality. * * The 'action_example_node_sticky_action' allows creating rules to promote and * set sticky content created by selected users on certain events. A form is * used to configure which user is affected by this action, and this form * includes the stanard _validate and _submit hooks. - */ - - -/** - * Generates settings form for action_example_node_sticky_action(). * - * @param array $context + * @param $context * An array of options of this action (in case it is being edited) * * @return array $form * + * @see action_example_action_info() */ function action_example_node_sticky_action_form($context) { /* @@ -332,8 +323,11 @@ function action_example_node_sticky_action_submit($form, $form_state) { } /** - * Promote and set sticky flag action. This is the special action that has been - * customized using the configuration form. + * Action function for action_example_node_sticky_action. + * + * Promote and set sticky flag. This is the special action that has been + * customized using the configuration form, validated with the validation + * function, and submitted with the submit function. * * @param $node * A node object provided by the associated trigger. @@ -341,8 +335,6 @@ function action_example_node_sticky_action_submit($form, $form_state) { * Array with the following elements: * - 'author': username of the author's content this function will promote and * set as sticky. - * - * @ingroup actions */ function action_example_node_sticky_action($node, $context) { if (function_exists('dsm')) { @@ -359,3 +351,6 @@ function action_example_node_sticky_action($node, $context) { drupal_set_message(t('Set @type %title to sticky and promoted by special action for user %username.', array('@type' => node_type_get_name($node), '%title' => $node->title, '%username' => $account->name))); } } +/** + * @} End of "defgroup action_example". + */ diff --git a/ajax_example/ajax_example.css b/ajax_example/ajax_example.css index 68bf370..e1cdc69 100644 --- a/ajax_example/ajax_example.css +++ b/ajax_example/ajax_example.css @@ -1,19 +1,17 @@ /* - * @file ajax_example.css - * CSS for ajax_example. + * @file + * CSS for ajax_example. * * See @link ajax_example_dependent_dropdown_degrades @endlink for * details on what this file does. It is not used in any other example. */ -/* hide the next button when not degrading to non-javascript browser */ +/* Hides the next button when not degrading to non-javascript browser */ html.js .next-button { display: none; } -/* Make the next/choose button align to the right of the select control */ +/* Makes the next/choose button align to the right of the select control */ .form-item-dropdown-first, .form-item-question-type-select { display: inline-block; } - - diff --git a/ajax_example/ajax_example.js b/ajax_example/ajax_example.js index 2f64d12..2d06038 100644 --- a/ajax_example/ajax_example.js +++ b/ajax_example/ajax_example.js @@ -1,10 +1,9 @@ /* - * @file ajax_example.js - * JavaScript for ajax_example. + * @file + * JavaScript for ajax_example. * * See @link ajax_example_dependent_dropdown_degrades @endlink for * details on what this file does. It is not used in any other example. - * */ (function($) { diff --git a/ajax_example/ajax_example.module b/ajax_example/ajax_example.module index ca842d3..3c4c197 100644 --- a/ajax_example/ajax_example.module +++ b/ajax_example/ajax_example.module @@ -6,7 +6,8 @@ */ /** - * @defgroup ajax_examples AJAX Examples + * @defgroup ajax_example Example: AJAX + * @ingroup examples * @{ * These examples show basic AJAX concepts. * @@ -15,16 +16,14 @@ * @link http://drupal.org/node/752056 AJAX Forms handbook page @endlink. * * The several examples here demonstrate basic AJAX usage. - * @} -*/ + */ /** * Implements hook_menu(). * * Sets up calls to drupal_get_form() for all our example cases. * - * See @link menu_example.module Menu Example @endlink for more details on - * hook_menu(). + * @see menu_example.module for more details on hook_menu(). */ function ajax_example_menu() { $items = array(); @@ -204,11 +203,6 @@ function ajax_example_intro() { } /** - * @ingroup ajax_examples - * @{ - */ - -/** * Simple form whose ajax-enabled 'changethis' member causes a text change * in the description of the 'replace_textfield' member. * See @link http://drupal.org/node/262422 Form API Tutorial @endlink @@ -528,7 +522,8 @@ function _ajax_example_get_first_dropdown_options() { * Helper function to populate the second dropdown. This would normally be * pulling data from the database. * - * @param key. This will determine which set of options is returned. + * @param $key + * This will determine which set of options is returned. * * @return array of options */ @@ -546,4 +541,6 @@ function _ajax_example_get_second_dropdown_options($key = '') { return array(); } } - +/** + * @} End of "defgroup ajax_example". + */ diff --git a/ajax_example/ajax_example_advanced.inc b/ajax_example/ajax_example_advanced.inc index 182465d..57e6079 100644 --- a/ajax_example/ajax_example_advanced.inc +++ b/ajax_example/ajax_example_advanced.inc @@ -8,8 +8,7 @@ * new AJAX commands. This is consolidated into a dense page because * it's advanced material and because it would spread itself all over creation * otherwise. - * -*/ + */ /** * Form to display the AJAX Commands. @@ -228,6 +227,7 @@ function ajax_example_advanced_commands($form, &$form_state) { /** * 'after' callback. + * * @see ajax_command_after() */ function ajax_example_advanced_commands_after_callback($form, $form_state) { @@ -241,6 +241,7 @@ function ajax_example_advanced_commands_after_callback($form, $form_state) { /** * 'alert' callback. + * * @see ajax_command_alert() */ function ajax_example_advanced_commands_alert_callback($form, $form_state) { @@ -251,6 +252,7 @@ function ajax_example_advanced_commands_alert_callback($form, $form_state) { /** * 'append' callback. + * * @see ajax_command_append() */ function ajax_example_advanced_commands_append_callback($form, $form_state) { @@ -264,6 +266,7 @@ function ajax_example_advanced_commands_append_callback($form, $form_state) { /** * 'before' callback. + * * @see ajax_command_before() */ function ajax_example_advanced_commands_before_callback($form, $form_state) { @@ -277,6 +280,7 @@ function ajax_example_advanced_commands_before_callback($form, $form_state) { /** * 'changed' callback. + * * @see ajax_command_changed() */ function ajax_example_advanced_commands_changed_callback($form, $form_state) { @@ -295,6 +299,7 @@ function ajax_example_advanced_commands_changed_callback($form, $form_state) { /** * 'css' callback. + * * @see ajax_command_css() */ function ajax_example_advanced_commands_css_callback($form, $form_state) { @@ -309,6 +314,7 @@ function ajax_example_advanced_commands_css_callback($form, $form_state) { /** * 'data' callback. + * * @see ajax_command_data() */ function ajax_example_advanced_commands_data_callback($form, $form_state) { @@ -324,6 +330,7 @@ function ajax_example_advanced_commands_data_callback($form, $form_state) { /** * 'html' callback. + * * @see ajax_command_html() */ function ajax_example_advanced_commands_html_callback($form, $form_state) { @@ -337,6 +344,7 @@ function ajax_example_advanced_commands_html_callback($form, $form_state) { /** * 'prepend' callback. + * * @see ajax_command_prepend() */ function ajax_example_advanced_commands_prepend_callback($form, $form_state) { @@ -348,6 +356,7 @@ function ajax_example_advanced_commands_prepend_callback($form, $form_state) { /** * 'remove' callback. + * * @see ajax_command_remove() */ function ajax_example_advanced_commands_remove_callback($form, $form_state) { @@ -366,6 +375,7 @@ function ajax_example_advanced_commands_remove_callback($form, $form_state) { /** * 'restripe' rows callback. + * * Rebuilds the table with the selected number of rows. */ function ajax_example_advanced_commands_restripe_num_rows($form, $form_state) { @@ -380,6 +390,7 @@ function ajax_example_advanced_commands_restripe_num_rows($form, $form_state) { /** * 'restripe' callback. + * * @see ajax_command_restripe() */ function ajax_example_advanced_commands_restripe_callback($form, $form_state) { diff --git a/ajax_example/ajax_example_graceful_degradation.inc b/ajax_example/ajax_example_graceful_degradation.inc index aa2a9ee..ce83e98 100644 --- a/ajax_example/ajax_example_graceful_degradation.inc +++ b/ajax_example/ajax_example_graceful_degradation.inc @@ -6,7 +6,8 @@ */ /** - * @defgroup ajax_degradation_examples AJAX Degradation Examples + * @defgroup ajax_degradation_example Example: AJAX Graceful Degradation + * @ingroup examples * @{ * These examples show AJAX with graceful degradation when Javascript is not * available. @@ -14,14 +15,8 @@ * In each of these the key idea is that the form is rebuilt different ways * depending on form input. In order to accomplish that, the formbuilder function * is in charge of almost all logic. - * - * @see ajax - * - * @} */ - - /** * A form with a dropdown whose options are dependent on a * choice made in a previous dropdown. @@ -39,9 +34,6 @@ * form as if Javascript were not enabled. ajax_example_menu() provides two * ways to call this form, one normal ($no_js_use = FALSE) and one simulating * Javascript disabled ($no_js_use = TRUE). - * - * @ingroup ajax_examples - * @ingroup ajax_degradation_examples */ function ajax_example_dependent_dropdown_degrades($form, &$form_state, $no_js_use = FALSE) { // Get the list of options to populate the first dropdown. @@ -147,9 +139,10 @@ function ajax_example_dependent_dropdown_degrades_submit($form, &$form_state) { } /** - * Selects just the second dropdown to be returned for re-rendering + * Selects just the second dropdown to be returned for re-rendering. * - * @return renderable array (the second dropdown) + * @return + * Renderable array (the second dropdown). */ function ajax_example_dependent_dropdown_degrades_first_callback($form, $form_state) { return $form['dropdown_second_fieldset']['dropdown_second']; @@ -166,11 +159,7 @@ function ajax_example_dependent_dropdown_degrades_first_callback($form, $form_st * * The third $no_js_use argument is strictly for demonstrating operation * without javascript, without making the user/developer turn off javascript. - * - * @ingroup ajax_examples - * @ingroup ajax_degradation_examples */ - function ajax_example_dynamic_sections($form, &$form_state, $no_js_use = FALSE) { // Attach the CSS and JS we need to show this with and without javascript. @@ -337,10 +326,6 @@ function ajax_example_dynamic_sections_select_callback($form, $form_state) { * Used for this demonstration only. If true means that the form should be * built using a simulated no-javascript approach (ajax.js will not be * loaded.) - * - * @ingroup ajax_examples - * @ingroup ajax_degradation_examples - * */ function ajax_example_wizard($form, &$form_state, $no_js_use = FALSE) { @@ -458,7 +443,6 @@ function ajax_example_wizard_callback($form, $form_state) { * In AJAX this is only submitted when the final submit button is clicked, * but in the non-javascript situation, it is submitted with every * button click. - * */ function ajax_example_wizard_submit($form, &$form_state) { @@ -491,7 +475,7 @@ function ajax_example_wizard_submit($form, &$form_state) { foreach ($form_state['storage']['values'] as $step => $values) { $value_message .= "$step: "; foreach ($values as $key => $value) { - $value_message .= "$key=$value, "; + $value_message .= "$key=$value, "; } } drupal_set_message($value_message); @@ -519,11 +503,7 @@ function ajax_example_wizard_submit($form, &$form_state) { * The $no_js_use argument is simply for demonstration: When set, it prevents * '#ajax' from being set, thus making the example behave as if javascript * were disabled in the browser. - * - * @ingroup ajax_examples - * @ingroup ajax_degradation_examples */ - function ajax_example_add_more($form, &$form_state, $no_js_use = FALSE) { $form['description'] = array( '#markup' => '
' . t('This example shows an add-more and a remove-last button. The AJAX version does it without page reloads; the non-js version is the same code but simulates a non-javascript environment, showing it with page reloads.', @@ -599,7 +579,7 @@ function ajax_example_add_more($form, &$form_state, $no_js_use = FALSE) { /** * Callback for both ajax-enabled buttons. * - * This simply selects and returns the fieldset with the names in it. + * Selects and returns the fieldset with the names in it. */ function ajax_example_add_more_callback($form, $form_state) { return $form['names_fieldset']; @@ -608,7 +588,7 @@ function ajax_example_add_more_callback($form, $form_state) { /** * Submit handler for the "add-one-more" button. * - * It just increments the max counter and causes a rebuild. + * Increments the max counter and causes a rebuild. */ function ajax_example_add_more_add_one($form, &$form_state) { $form_state['num_names']++; @@ -637,3 +617,6 @@ function ajax_example_add_more_submit($form, &$form_state) { array('@names' => implode(', ', $form_state['values']['names_fieldset']['name'])) ); drupal_set_message($output); } +/** + * @} End of "defgroup ajax_degradation_example". + */ diff --git a/ajax_example/ajax_example_misc.inc b/ajax_example/ajax_example_misc.inc index d7d1b16..4cb099e 100644 --- a/ajax_example/ajax_example_misc.inc +++ b/ajax_example/ajax_example_misc.inc @@ -13,7 +13,10 @@ * * When using the AJAX framework outside the context of a form or a renderable * array of type 'link', you have to include ajax.js explicitly. - * @return unknown_type + * + * @return + * + * @ingroup ajax_example */ function ajax_example_render_link() { // drupal_add_library is invoked automatically when a form element has the @@ -40,14 +43,16 @@ URL whether JS was enabled or not, letting it do different things based on that. * #ajax property. * * A link that is constructed as a renderable array can have the #ajax property, - * which ensures that the link submission is done without a page refresh. The href - * of the link is used as the ajax callback, but it degrades gracefully without - * JavaScript because if the 'nojs' portion of the href is not stripped out by js, - * the callback will return content as required for a full page reload. + * which ensures that the link submission is done without a page refresh. The + * href of the link is used as the ajax callback, but it degrades gracefully + * without JavaScript because if the 'nojs' portion of the href is not stripped + * out by js, the callback will return content as required for a full page + * reload. * * The necessary JavaScript file, ajax.js, will be included on the page * automatically. - * @return unknown_type + * + * @return */ function ajax_example_render_link_ra() { $explanation = " @@ -71,7 +76,6 @@ URL whether JS was enabled or not, letting it do different things based on that. 'method' => 'html', ), ); - return $build; } @@ -81,13 +85,15 @@ URL whether JS was enabled or not, letting it do different things based on that. * Takes different logic paths based on whether Javascript was enabled. * If $type == 'ajax', it tells this function that ajax.js has rewritten * the URL and thus we are doing an AJAX and can return an array of commands. + * * @param $type - * Either 'ajax' or 'nojs. Type is simply the normal URL argument to this - * URL. + * Either 'ajax' or 'nojs. Type is simply the normal URL argument to this URL. + * * @return * If $type == 'ajax', returns an array of AJAX Commands. * Otherwise, just returns the content, which will end up being a page. - * @see ajax + * + * @ingroup ajax_example */ function ajax_link_response($type = 'ajax') { if ($type == 'ajax') { diff --git a/batch_example/batch_example.install b/batch_example/batch_example.install index af015be..20ca484 100644 --- a/batch_example/batch_example.install +++ b/batch_example/batch_example.install @@ -21,6 +21,8 @@ * To make this update function run again and again, execute the query * "update system set schema_version = 0 where name = 'batch_example';" * and then run /update.php. + * + * @ingroup batch_example */ function batch_example_update_7100(&$sandbox) { $ret = array(); diff --git a/batch_example/batch_example.module b/batch_example/batch_example.module index e44169d..8a20a19 100644 --- a/batch_example/batch_example.module +++ b/batch_example/batch_example.module @@ -3,6 +3,13 @@ /** * @file * Outlines how a module can use the Batch API. + */ + +/** + * @defgroup batch_example Example: Batch API + * @ingroup examples + * @{ + * Outlines how a module can use the Batch API. * * Batches allow heavy processing to be spread out over several page * requests, ensuring that the processing does not get interrupted @@ -13,14 +20,11 @@ * The @link batch_example.install .install file @endlink also shows how the * Batch API can be used to handle long-running hook_update_N() functions. * - * @see batch - */ - -/** * Two harmless batches are defined: * - batch 1: Load the node with the lowest nid 100 times. * - batch 2: Load all nodes, 20 times and uses a progressive op, loading nodes * by groups of 5. + * @see batch */ /** @@ -82,12 +86,6 @@ function batch_example_simple_form_submit($form, &$form_state) { /** - * @defgroup batch_definitions Example batch definitions - * @{ - * Definitions of the batches used in this module. - */ - -/** * Batch 1 definition: Load the node with the lowest nid 1000 times. * This creates an operations array defining what batch 1 should do, including * what it should do when it's finished. In this case, each operation is the @@ -262,3 +260,6 @@ function _batch_example_update_http_requests() { function _batch_example_get_http_requests() { return !empty($_SESSION['http_request_count']) ? $_SESSION['http_request_count'] : 0; } +/** + * @} End of "defgroup batch_example". + */ diff --git a/batch_example/batch_example.test b/batch_example/batch_example.test index 70198fd..3431998 100644 --- a/batch_example/batch_example.test +++ b/batch_example/batch_example.test @@ -6,7 +6,6 @@ * * This file contains the test cases to check if module is performing as * expected. - * */ class BatchExampleTestCase extends DrupalWebTestCase { protected $web_user; diff --git a/block_example/block_example.install b/block_example/block_example.install index 13a9df8..6a23a64 100644 --- a/block_example/block_example.install +++ b/block_example/block_example.install @@ -7,6 +7,8 @@ /** * Implements hook_uninstall(). + * + * @ingroup block_example */ function block_example_uninstall() { variable_del('block_example_string'); diff --git a/block_example/block_example.module b/block_example/block_example.module index e5d5464..18c67ff 100755 --- a/block_example/block_example.module +++ b/block_example/block_example.module @@ -2,6 +2,15 @@ /** * @file + * Module file for block_example. + */ + +/** + * @defgroup block_example Example: Block + * @ingroup examples + * @{ + * Demonstrates code creation of blocks. + * * This is an example outlining how a module can define blocks that can be * displayed on various pages of a site, or how to alter blocks provided by * other modules. @@ -215,3 +224,6 @@ function block_example_block_view_alter(&$data, $block) { $data['subject'] = isset($data['subject']) ? drupal_strtoupper($data['subject']) : ''; } } +/** + * @} End of "defgroup block_example". + */ diff --git a/dbtng_example/dbtng_example.install b/dbtng_example/dbtng_example.install index 588b0bd..43f634e 100644 --- a/dbtng_example/dbtng_example.install +++ b/dbtng_example/dbtng_example.install @@ -14,6 +14,7 @@ * We will create a default entry in the database. * * @see hook_install() + * @ingroup dbtng_example */ function dbtng_example_install() { // Outside of the .install file we would use drupal_write_record() to @@ -50,20 +51,22 @@ function dbtng_example_install() { * for us. * * @see hook_uninstall() + * @ingroup dbtng_example */ function dbtng_example_uninstall() { + // nothing. } /** * Implements hook_schema(). * - * Define the database tables used by this module. + * Defines the database tables used by this module. * Remember that the easiest way to create the code for hook_schema is with - * the schema module: - * @link http://drupal.org/project/schema @endlink + * the @link http://drupal.org/project/schema schema module @endlink * * @see hook_schema() + * @ingroup dbtng_example */ function dbtng_example_schema() { diff --git a/dbtng_example/dbtng_example.module b/dbtng_example/dbtng_example.module index 352d2d6..5dad999 100644 --- a/dbtng_example/dbtng_example.module +++ b/dbtng_example/dbtng_example.module @@ -13,13 +13,16 @@ */ /** - * @defgroup database_examples Database Examples + * @defgroup dbtng_example Example: Database (DBTNG) + * @ingroup examples * @{ - * These examples show basic database examples, including DBTNG. + * Database examples, including DBTNG. + * + * 'DBTNG' means 'Database: The Next Generation.' Yes, Drupallers are nerds. * * General documentation is available at - * @link database Database abstraction layer documentation @endlink and - * at @link http://drupal.org/node/310069 @endlink. + * @link database.inc database abstraction layer documentation @endlink and + * at @link http://drupal.org/node/310069 Database API @endlink. * * The several examples here demonstrate basic database usage. * @@ -62,7 +65,6 @@ * @see db_update() * @see db_delete() * @see drupal_write_record() - * @} */ /** @@ -89,7 +91,6 @@ * @param $entry * An array containing all the fields of the database record. * - * @ingroup database_examples * @see db_insert() */ function dbtng_example_entry_insert($entry) { @@ -126,7 +127,6 @@ function dbtng_example_entry_insert($entry) { * @param $entry * An array containing all the fields of the item to be updated. * - * @ingroup database_examples * @see db_update() */ function dbtng_example_entry_update($entry) { @@ -157,7 +157,6 @@ function dbtng_example_entry_update($entry) { * An array containing at least the person identifier 'pid' element of the * entry to delete. * - * @ingroup database_examples * @see db_delete() */ function dbtng_example_entry_delete($entry) { @@ -239,7 +238,6 @@ function dbtng_example_entry_delete($entry) { * @return * An object containing the loaded entries if found. * - * @ingroup database_examples * @see db_select() * @see db_query() * @see http://drupal.org/node/310072 @@ -568,3 +566,6 @@ function dbtng_example_form_update_submit($form, $form_state) { $count = dbtng_example_entry_update($entry); drupal_set_message(t("Updated entry @entry (@count row updated)", array('@count' => $count, '@entry' => print_r($entry, TRUE)))); } +/** + * @} End of "defgroup dbtng_example". + */ diff --git a/dbtng_example/dbtng_example.test b/dbtng_example/dbtng_example.test index ab732d3..6d16e7e 100644 --- a/dbtng_example/dbtng_example.test +++ b/dbtng_example/dbtng_example.test @@ -2,7 +2,7 @@ /** * @file - * test file for dbtng_example module. + * SimpleTests for dbtng_example module. */ /** @@ -178,4 +178,3 @@ class DBTNGExampleUnitTestCase extends DrupalWebTestCase { ); } } - diff --git a/email_example/email_example.module b/email_example/email_example.module index e5ab92a..c88abb7 100644 --- a/email_example/email_example.module +++ b/email_example/email_example.module @@ -3,11 +3,18 @@ /** * @file * Example of how to use Drupal's mail API. + */ + +/** + * @defgroup email_example Example: Email + * @ingroup examples + * @{ + * Example of how to use Drupal's mail API. * - * This example module provides two different examples of the Drupal email API. - * - defines a simple contact form and shows how to use drupal_mail() + * This example module provides two different examples of the Drupal email API: + * - Defines a simple contact form and shows how to use drupal_mail() * to send an e-mail (defined in hook_mail()) when the form is submitted. - * - shows how modules can alter emails defined by other Drupal modules or + * - Shows how modules can alter emails defined by other Drupal modules or * Core using hook_mail_alter by attaching a custom signature before * they are sent. */ @@ -60,7 +67,7 @@ function email_example_mail($key, &$message, $params) { } /** - * Send an e-mail. + * Sends an e-mail. * * @param $form_values * An array of values from the contact form fields that were submitted. @@ -199,3 +206,6 @@ function email_example_form_validate($form, &$form_state) { function email_example_form_submit($form, &$form_state) { email_example_mail_send($form_state['values']); } +/** + * @} End of "defgroup email_example". + */ diff --git a/email_example/email_example.test b/email_example/email_example.test index b673670..aa70ea1 100644 --- a/email_example/email_example.test +++ b/email_example/email_example.test @@ -95,4 +95,3 @@ class EmailExampleTestCase extends DrupalWebTestCase { ); } } - diff --git a/examples.index.php b/examples.index.php deleted file mode 100644 index beab81a..0000000 --- a/examples.index.php +++ /dev/null @@ -1,31 +0,0 @@ - array( 'label' => t('Example Color RGB'), 'description' => t('Demonstrates a field composed of an RGB color.'), @@ -50,8 +71,14 @@ function field_example_field_info() { /** * Implements hook_field_validate(). * - * Verifies that the RGB field as combined is valid - * (6 hex digits with a # at the beginning). + * This hook gives us a chance to validate content that's in our + * field. We're really only interested in the $items parameter, since + * it holds arrays representing content in the field we've defined. + * We want to verify that the items only contain RGB hex values like + * this: #RRGGBB. If the item validates, we do nothing. If it doesn't + * validate, we add our own error notification to the $errors parameter. + * + * @see field_example_field_widget_error() */ function field_example_field_validate($entity_type, $entity, $field, $instance, $langcode, $items, &$errors) { foreach ($items as $delta => $item) { @@ -69,20 +96,23 @@ function field_example_field_validate($entity_type, $entity, $field, $instance, /** * Implements hook_field_is_empty(). + * + * hook_field_is_emtpy() is where Drupal asks us if this field is empty. + * Return TRUE if it does not contain data, FALSE if it does. This lets + * the form API flag an error when required fields are empty. */ function field_example_field_is_empty($item, $field) { return empty($item['rgb']); } -/*********************************************************************** - * Field Type API: Formatter - * - * These are the api hooks that present formatted (themed) output to the - * user. - **********************************************************************/ - /** * Implements hook_field_formatter_info(). + * + * We need to tell Drupal that we have two different types of formatters + * for this field. One will change the text color, and the other will + * change the background color. + * + * @see field_example_field_formatter_view() */ function field_example_field_formatter_info() { return array( @@ -107,6 +137,8 @@ function field_example_field_formatter_info() { * was entered and uses an inline style to set the text color to that value. * - field_example_color_background does the same but also changes the * background color of div.region-content. + * + * @see field_example_field_formatter_info() */ function field_example_field_formatter_view($entity_type, $entity, $field, $instance, $langcode, $items, $display) { $element = array(); @@ -132,14 +164,6 @@ function field_example_field_formatter_view($entity_type, $entity, $field, $inst return $element; } - -/************************************************************************** - * Field Type API: Widget - * - * The widget is the form element used to receive input from the user - * when the field is being populated. - **************************************************************************/ - /** * Implements hook_field_widget_info(). * @@ -148,6 +172,11 @@ function field_example_field_formatter_view($entity_type, $entity, $field, $inst * - A 3-textfield widget that gathers the red, green, and blue values * separately. * - A farbtastic colorpicker widget that chooses the value graphically. + * + * These widget types will eventually show up in hook_field_widget_form, + * where we will have to flesh them out. + * + * @see field_example_field_widget_form() */ function field_example_field_widget_info() { return array( @@ -169,7 +198,11 @@ function field_example_field_widget_info() { /** * Implements hook_field_widget_form(). * - * Three different forms are provided, for the three widget types. + * hook_widget_form() is where Drupal tells us to create form elements for + * our field's widget. + * + * We provide one of three different forms, depending on the widget type of + * the Form API item provided. * * The 'field_example_colorpicker' and 'field_example_text' are essentially * the same, but field_example_colorpicker adds a javascript colorpicker @@ -288,6 +321,13 @@ function field_example_3text_validate($element, &$form_state) { /** * Implements hook_field_widget_error(). + * + * hook_field_widget_error() lets us figure out what to do with errors + * we might have generated in hook_field_validate(). Generally, we'll just + * call form_error(). + * + * @see field_example_field_validate() + * @see form_error() */ function field_example_field_widget_error($element, $error, $form, &$form_state) { switch ($error['error']) { @@ -318,3 +358,6 @@ function field_example_menu() { function _field_example_page() { return t("The Field Example provides a field composed of an HTML RGB value, like #ff00ff. To use it, add the field to a content type."); } +/** + * @} End of "defgroup field_example". + */ diff --git a/field_example/field_example.test b/field_example/field_example.test index 76ad9d4..2f87c61 100644 --- a/field_example/field_example.test +++ b/field_example/field_example.test @@ -32,7 +32,7 @@ class FieldExampleTest extends DrupalWebTestCase { */ function testExampleFieldBasic() { $content_type_friendly = $this->randomName(20); - $content_type_machine = strtolower($this->randomName(10)); + $content_type_machine = drupal_strtolower($this->randomName(10)); $title = $this->randomName(20); // Create and login user. @@ -45,7 +45,7 @@ class FieldExampleTest extends DrupalWebTestCase { $this->clickLink(t('Add content type')); $single_field_name_friendly = $this->randomName(20); - $single_field_name_machine = strtolower($this->randomName(10)); + $single_field_name_machine = drupal_strtolower($this->randomName(10)); $edit = array( 'name' => $content_type_friendly, @@ -74,7 +74,7 @@ class FieldExampleTest extends DrupalWebTestCase { // Now we're back on the field-add page. // Now add a multivalued field. $multivalue_field_name_friendly = $this->randomName(20); - $multivalue_field_name_machine = strtolower($this->randomName(10)); + $multivalue_field_name_machine = drupal_strtolower($this->randomName(10)); $edit = array( 'fields[_add_new_field][label]' => $multivalue_field_name_friendly, 'fields[_add_new_field][field_name]' => $multivalue_field_name_machine, diff --git a/file_example/file_example.module b/file_example/file_example.module index d704722..c5cb3ec 100644 --- a/file_example/file_example.module +++ b/file_example/file_example.module @@ -6,6 +6,11 @@ */ /** + * @defgroup file_example Example: Files + * @ingroup examples + * @{ + * Examples demonstrating the Drupal File API (and Stream Wrappers). + * * The File Example module is a part of the Examples for Developers Project * and provides various Drupal File API Examples. You can download and * experiment with this code at the @@ -14,8 +19,6 @@ * See @link http://drupal.org/node/555118 Drupal File API @endlink for handbook * documentation on the File API and * @link file File summary on api.drupal.org @endlink for the function summary. - * - * @defgroup file_example Examples: File Examples */ /** @@ -63,7 +66,6 @@ function file_example_permission() { * * A simple form that allows creation of a file, managed or unmanaged. It * also allows reading/deleting a file and creation of a directory. - * @ingroup file_example */ function file_example_readwrite($form, &$form_state) { if (empty($_SESSION['file_example_default_file'])) { @@ -191,7 +193,6 @@ function file_example_readwrite($form, &$form_state) { * - file_create_url(), which converts a URI in the form public://junk.txt or * private://something/test.txt into a URL like * http://example.com/sites/default/files/junk.txt. - * @ingroup file_example */ function file_example_managed_write_submit($form, &$form_state) { $data = $form_state['values']['write_contents']; @@ -220,7 +221,6 @@ function file_example_managed_write_submit($form, &$form_state) { * - file_create_url(), which converts a URI in the form public://junk.txt or * private://something/test.txt into a URL like * http://example.com/sites/default/files/junk.txt. - * @ingroup file_example */ function file_example_unmanaged_write_submit($form, &$form_state) { @@ -251,7 +251,6 @@ function file_example_unmanaged_write_submit($form, &$form_state) { * private://something/test.txt into a URL like * http://example.com/sites/default/files/junk.txt. * - drupal_tempnam() generates a temporary filename for use. - * @ingroup file_example */ function file_example_unmanaged_php_submit($form, &$form_state) { @@ -305,7 +304,6 @@ function file_example_unmanaged_php_submit($form, &$form_state) { * file_get_contents("public://somefile.txt") just works. Although it's * not necessary, we use file_unmanaged_save_data() to save this file locally * and then find a local URL for it by using file_create_url(). - * @ingroup file_example */ function file_example_read_submit($form, &$form_state) { $uri = $form_state['values']['fileops_file']; @@ -390,7 +388,6 @@ function file_example_file_check_exists_submit($form, &$form_state) { * Submit handler for directory creation. * Here we create a directory and set proper permissions on it using * file_prepare_directory(). - * @ingroup file_example */ function file_example_create_directory_submit($form, &$form_state) { $directory = $form_state['values']['directory_name']; @@ -416,7 +413,6 @@ function file_example_create_directory_submit($form, &$form_state) { * * @see file_unmanaged_delete_recursive() * - * @ingroup file_example */ function file_example_delete_directory_submit($form, &$form_state) { $directory = $form_state['values']['directory_name']; @@ -434,8 +430,9 @@ function file_example_delete_directory_submit($form, &$form_state) { /** * Submit handler to test directory existence. * This actually just checks to see if the directory is writable - * @param unknown_type $form - * @param unknown_type $form_state + * + * @param $form + * @param $form_state */ function file_example_check_directory_submit($form, &$form_state) { $directory = $form_state['values']['directory_name']; @@ -487,8 +484,6 @@ function file_example_get_managed_file($uri) { * is readable and writable as a location in the $_SESSION variable. * * @see FileExampleSessionStreamWrapper - * - * defgroup streamwrapper_example Stream Wrapper Example */ function file_example_stream_wrappers() { $wrappers = array( @@ -518,4 +513,6 @@ function file_example_session_contents() { $content = file_get_contents('session://' . $session_path); return t('Contents of @path:', array('@path' => check_plain($session_path))) . ' ' . print_r($content, TRUE); } - +/** + * @} End of "defgroup file_example". + */ diff --git a/file_example/file_example_session_streams.inc b/file_example/file_example_session_streams.inc index 1d29034..309fc59 100644 --- a/file_example/file_example_session_streams.inc +++ b/file_example/file_example_session_streams.inc @@ -2,13 +2,15 @@ /** * @file - * Implements DrupalStreamWrapperInterface to provide a demonstration session:// - * streamwrapper. This example is nearly fully functional, but has no known + * Provides a demonstration session:// streamwrapper. + * + * This example is nearly fully functional, but has no known * practical use. It's an example and demonstration only. */ /** * Example stream wrapper class to handle session:// streams. + * * This is just an example, as it could have horrible results if much * information were placed in the $_SESSION variable. However, it does * demonstrate both the read and write implementation of a stream wrapper. @@ -33,6 +35,8 @@ * Note that because this implementation uses simple PHP arrays ($_SESSION) * it is limited to string values, so binary files will not work correctly. * Only text files can be used. + * + * @ingroup file_example */ class FileExampleSessionStreamWrapper implements DrupalStreamWrapperInterface { /** @@ -54,6 +58,7 @@ class FileExampleSessionStreamWrapper implements DrupalStreamWrapperInterface { /** * The content of the stream. + * * Since this trivial example just uses the $_SESSION variable, this is * simply a reference to the contents of the related part of * $_SESSION['file_example']. @@ -94,9 +99,10 @@ class FileExampleSessionStreamWrapper implements DrupalStreamWrapperInterface { } /** - * Implements getTarget(). - * The "target" is the portion of the URI to the right of the scheme. - * So in session://example/test.txt, the target is 'example/test.txt'. + * Implements getTarget(). + * + * The "target" is the portion of the URI to the right of the scheme. + * So in session://example/test.txt, the target is 'example/test.txt'. */ function getTarget($uri = NULL) { if (!isset($uri)) { @@ -133,7 +139,7 @@ class FileExampleSessionStreamWrapper implements DrupalStreamWrapperInterface { // - image.jpeg, and // - awesome.image.jpeg while ($additional_part = array_pop($file_parts)) { - $extension = strtolower($additional_part . ($extension ? '.' . $extension : '')); + $extension = drupal_strtolower($additional_part . ($extension ? '.' . $extension : '')); if (isset($mapping['extensions'][$extension])) { return $mapping['mimetypes'][$mapping['extensions'][$extension]]; } @@ -144,6 +150,7 @@ class FileExampleSessionStreamWrapper implements DrupalStreamWrapperInterface { /** * Implements getDirectoryPath(). + * * In this case there is no directory string, so return an empty string. */ public function getDirectoryPath() { @@ -152,6 +159,7 @@ class FileExampleSessionStreamWrapper implements DrupalStreamWrapperInterface { /** * Overrides getExternalUrl(). + * * We have set up a helper function and menu entry to provide access to this * key via HTTP; normally it would be accessible some other way. */ @@ -230,6 +238,7 @@ class FileExampleSessionStreamWrapper implements DrupalStreamWrapperInterface { /** * Return a reference to the correct $_SESSION key. + * * @param $uri * The uri: session://something * @param $create @@ -244,7 +253,7 @@ class FileExampleSessionStreamWrapper implements DrupalStreamWrapperInterface { $fail = FALSE; $var = &$_SESSION['file_example']; // Handle case of just session://. - if (strlen($path) == 0) { + if (drupal_strlen($path) == 0) { return $var; } foreach ($path_components as $component) { @@ -257,8 +266,10 @@ class FileExampleSessionStreamWrapper implements DrupalStreamWrapperInterface { } return $var; } + /** * Support for flock(). + * * The $_SESSION variable has no locking capability, so return TRUE. * * @param $operation @@ -291,10 +302,10 @@ class FileExampleSessionStreamWrapper implements DrupalStreamWrapperInterface { */ public function stream_read($count) { if (is_string($this->session_content)) { - $remaining_chars = strlen($this->session_content) - $this->stream_pointer; + $remaining_chars = drupal_strlen($this->session_content) - $this->stream_pointer; $number_to_read = min($count, $remaining_chars); if ($remaining_chars > 0) { - $buffer = substr($this->session_content, $this->stream_pointer, $number_to_read); + $buffer = drupal_substr($this->session_content, $this->stream_pointer, $number_to_read); $this->stream_pointer += $number_to_read; return $buffer; } @@ -318,8 +329,8 @@ class FileExampleSessionStreamWrapper implements DrupalStreamWrapperInterface { // session variable. $data = check_plain($data); $this->session_content = substr_replace($this->session_content, $data, $this->stream_pointer); - $this->stream_pointer += strlen($data); - return strlen($data); + $this->stream_pointer += drupal_strlen($data); + return drupal_strlen($data); } /** @@ -348,7 +359,7 @@ class FileExampleSessionStreamWrapper implements DrupalStreamWrapperInterface { * @see http://php.net/manual/en/streamwrapper.stream-seek.php */ public function stream_seek($offset, $whence) { - if (strlen($this->session_content) >= $offset) { + if (drupal_strlen($this->session_content) >= $offset) { $this->stream_pointer = $offset; return TRUE; } @@ -543,6 +554,7 @@ class FileExampleSessionStreamWrapper implements DrupalStreamWrapperInterface { /** * Support for stat(). + * * This important function goes back to the Unix way of doing things. * In this example almost the entire stat array is irrelevant, but the * mode is very important. It tells PHP whether we have a file or a diff --git a/filter_example/filter_example.module b/filter_example/filter_example.module index bbf0296..97c5a12 100755 --- a/filter_example/filter_example.module +++ b/filter_example/filter_example.module @@ -2,13 +2,40 @@ /** * @file + * Module file for filter_example. + */ + +/** + * @defgroup filter_example Example: Filter + * @ingroup examples + * @{ + * Demonstrates the creation of filters. + * This is an example outlining how a module can be used to define a filter * to be run on user-submitted content before it is output to the browser. * * To show all the capabilities of the filter system, we will define two filters - * in this module. One will substitute the string "foo" with an administratively- - * defined replacement string. The other will find a custom XML tag,
'; return $output; } - diff --git a/nodeapi_example/nodeapi_example.test b/nodeapi_example/nodeapi_example.test index e16ef8e..6518fae 100644 --- a/nodeapi_example/nodeapi_example.test +++ b/nodeapi_example/nodeapi_example.test @@ -6,7 +6,6 @@ * * This file contains the test cases to check if module is performing as * expected. - * */ class NodeApiExampleTestCase extends DrupalWebTestCase { /** @@ -30,7 +29,7 @@ class NodeApiExampleTestCase extends DrupalWebTestCase { } /** - * Enable modules and create user with specific permissions. + * Enables modules and create user with specific permissions. */ function setUp() { parent::setUp('nodeapi_example'); @@ -49,7 +48,7 @@ class NodeApiExampleTestCase extends DrupalWebTestCase { } /** - * Login user, create an example node, and use the rating system + * Log user in, creates an example node, and uses the rating system. */ function testNodeExampleBasic() { @@ -116,7 +115,7 @@ class NodeApiExampleTestCase extends DrupalWebTestCase { } /** - * Login user, create an example node, and test rating functionality with + * Logs user in, creates an example node, and tests rating functionality with * a node using revisions. */ function testNodeExampleRevision() { diff --git a/page_example/page_example.module b/page_example/page_example.module index 500f6d9..8ebf2d1 100755 --- a/page_example/page_example.module +++ b/page_example/page_example.module @@ -2,6 +2,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. */ @@ -116,9 +123,13 @@ 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. * @@ -165,3 +176,6 @@ function page_example_arguments($first, $second) { ); return $render_array; } +/** + * @} End of "defgroup page_example". + */ diff --git a/queue_example/queue_example.module b/queue_example/queue_example.module index 4eecab1..b66b3ec 100644 --- a/queue_example/queue_example.module +++ b/queue_example/queue_example.module @@ -3,6 +3,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: @@ -210,7 +217,7 @@ function queue_example_add_remove_form_clear_queue($form, &$form_state) { } /** - * Retrieve the queue from the database for display purposes only. + * Retrieves the queue from the database for display purposes only. * * It is not recommended to access the database directly, and this is only here * so that the user interface can give a good idea of what's going on in the @@ -231,7 +238,7 @@ function queue_example_retrieve_queue($queue_name) { } /** - * Theme the queue display. + * Themes the queue display. * * Again, this is not part of the demonstration of the queue API, but is here * just to make the user interface more understandable. @@ -273,3 +280,6 @@ function queue_example_theme() { ), ); } +/** + * @} End of "defgroup queue_example". + */ diff --git a/render_example/render_example.module b/render_example/render_example.module index 8e7730f..d1c307f 100644 --- a/render_example/render_example.module +++ b/render_example/render_example.module @@ -2,7 +2,14 @@ /** * @file - * Demonstrates how render arrays are arranged and how they can be altered. + * Demonstrates render arrays. + */ + +/** + * @defgroup render_example Example: Render + * @ingroup examples + * @{ + * Demonstrate how render arrays are arranged and how they can be altered. * This alters blocks and the page to show the actual render array * that is being used to create each item. * @@ -47,6 +54,7 @@ function render_example_info() { /** * Provides a number of render arrays and show what they do. + * * Each array is keyed by a description; it's returned for rendering at page * render time. It's easy to add new examples to this. * @@ -190,6 +198,7 @@ function render_example_add_suffix($element) { * The rendered element. * @param $element * The element which was rendered (for reference) + * * @return * Markup altered as necessary. In this case we add a little postscript to it. */ @@ -199,7 +208,9 @@ function render_example_add_prefix($markup, $element) { } /** - * A #theme function has the responsibility of consolidating/rendering the + * A #theme function. + * + * This #theme function has the responsibility of consolidating/rendering the * children's markup and returning it, where it will be placed in the * element's #children property. */ @@ -215,6 +226,7 @@ function theme_render_example_aggregate($variables) { * The following section of the example builds and arranges the altering * example. */ + /** * Builds the form that offers options of what items to show. */ @@ -397,6 +409,7 @@ function render_example_page_alter(&$page) { /** * Utility function to build a named form given a set of form elements. + * * This is a standard form builder function that takes an additional array, * which is itself a form. * @@ -433,7 +446,7 @@ function render_example_theme() { } /** - * Wrap a div around the already-rendered #children. + * Wraps a div around the already-rendered #children. */ function theme_render_example_add_div($variables) { $element = $variables['element']; @@ -444,7 +457,7 @@ function theme_render_example_add_div($variables) { } /** - * Wrap a div and add a little text after the rendered #children. + * Wraps a div and add a little text after the rendered #children. */ function theme_render_example_add_notes($variables) { $element = $variables['element']; @@ -457,7 +470,7 @@ function theme_render_example_add_notes($variables) { } /** - * Theme render array (from the demonstration page). + * Themes the render array (from the demonstration page). */ function theme_render_array($variables) { $heading = '
' . $variables['element']['#description'] . '
'; @@ -467,8 +480,9 @@ function theme_render_array($variables) { } /** - * Add a #type to the element before it gets rendered. + * Adds a #type to the element before it gets rendered. * In this case, changes from the default 'ul' to 'ol'. + * * @param $element * The element to be altered, in this case a list, ready for theme_item_list. * @@ -485,6 +499,7 @@ function render_example_change_to_ol($element) { * theme functions have acted on it, and it receives the original data, so * can make decisions based on that. In this example, no use is made of the * passed-in $element. + * * @param $markup * The already-rendered data * @param unknown_type $element @@ -497,3 +512,6 @@ function render_example_add_hr($markup, $element) { $output = $markup . '
'; return $output; } +/** + * @} End of "defgroup render_example". + */ diff --git a/simpletest_example/simpletest_example.module b/simpletest_example/simpletest_example.module index ea77b2a..16048f2 100644 --- a/simpletest_example/simpletest_example.module +++ b/simpletest_example/simpletest_example.module @@ -2,13 +2,19 @@ /** * @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. * * This is built on a traditional node-type implementation. */ - /** * Implements hook_node_info(). */ @@ -87,7 +93,7 @@ function simpletest_example_form($node, $form_state) { /** * Implements hook_menu(). * - * Provide an explanation. + * Provides an explanation. */ function simpletest_example_menu() { $items['examples/simpletest_example'] = array( @@ -100,7 +106,7 @@ function simpletest_example_menu() { } /** - * Return an explanation of this module. + * Returns an explanation of this module. */ function _simpletest_example_explanation() { @@ -108,4 +114,6 @@ function _simpletest_example_explanation() { a simpletest test. Please see the associated tutorial."); return $explanation; } - +/** + * @} End of "defgroup simpletest_example". + */ diff --git a/token_example/token_example.module b/token_example/token_example.module index dac5762..99919da 100644 --- a/token_example/token_example.module +++ b/token_example/token_example.module @@ -3,6 +3,24 @@ /** * @file * An example module showing how to define and use tokens. + * + * 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 */ /** @@ -117,7 +135,7 @@ function token_example_example_form_submit($form, &$form_state) { } /** - * Build a list of available content. + * Builds a list of available content. */ function _token_example_get_node() { if (!user_access('access content') && !user_access('bypass node access')) { @@ -136,7 +154,7 @@ function _token_example_get_node() { } /** - * Build a list of available comments. + * Builds a list of available comments. */ function _token_example_get_comment() { if (!module_exists('comment') || (!user_access('access comments') && !user_access('administer comments'))) { @@ -157,10 +175,11 @@ function _token_example_get_comment() { } /** - * Build a list of available user accounts. + * Builds a list of available user accounts. */ function _token_example_get_user() { - if (!user_access('access user profiles') && !user_access('administer users')) { + if (!user_access('access user profiles') && + !user_access('administer users')) { return array(); } @@ -175,7 +194,7 @@ function _token_example_get_user() { } /** - * Build a list of available taxonomy terms. + * Builds a list of available taxonomy terms. */ function _token_example_get_taxonomy_term() { $term_query = db_select('taxonomy_term_data', 'ttd'); @@ -188,7 +207,7 @@ function _token_example_get_taxonomy_term() { } /** - * Build a list of available files. + * Builds a list of available files. */ function _token_example_get_file() { $file_query = db_select('file_managed', 'f'); @@ -198,3 +217,6 @@ function _token_example_get_file() { $files = array_map('check_plain', $files); return $files; } +/** + * @} End of "defgroup token_example". + */ diff --git a/token_example/token_example.tokens.inc b/token_example/token_example.tokens.inc index 462e0c9..d62a329 100644 --- a/token_example/token_example.tokens.inc +++ b/token_example/token_example.tokens.inc @@ -7,6 +7,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 @@ -54,6 +56,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 a/trigger_example/trigger_example.module b/trigger_example/trigger_example.module index cac508c..5a9b13e 100644 --- a/trigger_example/trigger_example.module +++ b/trigger_example/trigger_example.module @@ -3,6 +3,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 @@ -115,7 +123,8 @@ function trigger_example_trigger_info() { * This function is executed during the submission of the example form defined * in this module. * - * @param array $options arguments used to call the triggersomething function, if any. + * @param $options + * Array of arguments used to call the triggersomething function, if any. */ function trigger_example_triggersomething($options = array()) { // Ask the trigger module for all actions enqueued for the 'triggersomething' trigger. @@ -145,7 +154,6 @@ function trigger_example_triggersomething($options = array()) { * it can be used. We use hook_user_login to be informed when a user logs in and * try to find if the user has previously logged in before. If the user has not * accessed previously, we make a call to our trigger function. - * */ function trigger_example_user_login(&$edit, $account, $category = NULL) { // Verify user has never accessed the site: last access was creation date. @@ -173,14 +181,13 @@ function trigger_example_user_login(&$edit, $account, $category = NULL) { * @endcode * * @param string $hook - * the trigger identification. + * The trigger identification. * @param array $edit - * modifications for the account object (should be empty). + * Modifications for the account object (should be empty). * @param object $account - * user object that has logged in. + * User object that has logged in. * @param string $category - * category of the profile. - * + * Category of the profile. */ function _trigger_example_first_time_login($hook, &$edit, $account, $category = NULL) { // Keep objects for reuse so that changes actions make to objects can persist. @@ -245,7 +252,7 @@ function trigger_example_help($path, $arg) { /** * Implements hook_menu(). * - * Provide a form that can be used to fire the module's triggers. + * Provides a form that can be used to fire the module's triggers. */ function trigger_example_menu() { $items['examples/trigger_example'] = array( @@ -259,9 +266,9 @@ function trigger_example_menu() { } /** - * Trigger example test form + * Trigger example test form. * - * Provide a button to run the triggersomething event. + * Provides a button to run the triggersomething event. */ function trigger_example_form($form_state) { $form['triggersomething'] = array( @@ -272,7 +279,7 @@ function trigger_example_form($form_state) { } /** - * Submit handler for the trigger_example_form. + * Submit handler for the trigger_example_form(). */ function trigger_example_form_submit($form, $form_state) { // If the user clicked the button, then run the triggersomething trigger. @@ -283,11 +290,10 @@ function trigger_example_form_submit($form, $form_state) { /** - * Optional usage of hook_trigger_info_aler() + * Optional usage of hook_trigger_info_alter(). * * This function is not required to write your own triggers, but it may be * useful when you want to alter existing triggers. - * */ /** @@ -299,9 +305,9 @@ function trigger_example_form_submit($form, $form_state) { * this example implementation a little change is done to the existing trigger * provided by core: 'cron' * - * @param array $triggers - * Array of trigger information returned by hook_trigger_info() - * implementations. + * @param $triggers + * Array of trigger information returned by hook_trigger_info() + * implementations. * * @see hook_trigger_info() */ diff --git a/vertical_tabs_example/vertical_tabs_example.module b/vertical_tabs_example/vertical_tabs_example.module index fec4345..faab1a6 100644 --- a/vertical_tabs_example/vertical_tabs_example.module +++ b/vertical_tabs_example/vertical_tabs_example.module @@ -2,9 +2,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 */ /** @@ -86,3 +96,6 @@ 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". + */ diff --git a/xmlrpc_example/xmlrpc_example.module b/xmlrpc_example/xmlrpc_example.module index 225624c..d1d301e 100644 --- a/xmlrpc_example/xmlrpc_example.module +++ b/xmlrpc_example/xmlrpc_example.module @@ -2,6 +2,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. @@ -24,7 +33,8 @@ /** * Implements hook_menu(). - * Register all the demonstration forms. + * + * Registers all the demonstration forms. */ function xmlrpc_example_menu() { $items['examples/xmlrpc'] = array( @@ -55,7 +65,7 @@ function xmlrpc_example_menu() { 'access callback' => TRUE, 'weight' => 1, ); - // This part is completely optional. It will allow the modification of services + // This part is completely optional. It allows the modification of services // defined by this or other modules. This configuration form is used to // enable the hook_xmlrpc_alter API and alter current existing services $items['examples/xmlrpc/alter'] = array( @@ -643,5 +653,6 @@ function xmlrpc_example_alter_form() { ); return system_settings_form($form); } - -// The alteration part of the module ends here. +/** + * @} End of "defgroup xmlrpc_example". + */