Commit 698de321 authored by jhodgdon's avatar jhodgdon

Issue #1397346 by Albert Volkman: Fix up some image/node function documentation

parent f85ba574
......@@ -265,7 +265,7 @@ function image_form_system_file_system_settings_alter(&$form, &$form_state) {
}
/**
* Submit handler for the file system settings form.
* Form submission handler for system_file_system_settings().
*
* Adds a menu rebuild after the public file path has been changed, so that the
* menu router item depending on that file path will be regenerated.
......@@ -512,7 +512,7 @@ function image_field_update_instance($instance, $prior_instance) {
}
/**
* Clear cached versions of a specific file in all styles.
* Clears cached versions of a specific file in all styles.
*
* @param $path
* The Drupal file path to the original image.
......@@ -555,7 +555,7 @@ function image_image_style_load($styles) {
}
/**
* Get an array of image styles suitable for using as select list options.
* Gets an array of image styles suitable for using as select list options.
*
* @param $include_empty
* If TRUE a <none> option will be inserted in the options array.
......@@ -579,7 +579,7 @@ function image_style_options($include_empty = TRUE) {
}
/**
* Menu callback; Given a style and image path, generate a derivative.
* Page callback: Generates a derivative, given a style and image path.
*
* After generating an image, transfer it to the requesting agent.
*
......@@ -745,7 +745,7 @@ function image_style_transform_dimensions($style_name, array &$dimensions) {
}
/**
* Flush cached media for a style.
* Flushes cached media for a style.
*
* @param $style
* An image style array.
......@@ -771,7 +771,7 @@ function image_style_flush($style) {
}
/**
* Return the URL for an image derivative given a style and image path.
* Returns the URL for an image derivative given a style and image path.
*
* @param $style_name
* The name of the style to be used with this image.
......@@ -798,7 +798,7 @@ function image_style_url($style_name, $path) {
}
/**
* Return the URI of an image when using a style.
* Returns the URI of an image when using a style.
*
* The path returned by this function may not exist. The default generation
* method only creates images when they are requested by a user's browser.
......@@ -824,7 +824,10 @@ function image_style_path($style_name, $uri) {
}
/**
* Pull in image effects exposed by modules implementing hook_image_effect_info().
* Returns a set of image effects.
*
* These image effects are exposed by modules implementing
* hook_image_effect_info().
*
* @return
* An array of image effects to be used when transforming images.
......@@ -866,7 +869,7 @@ function image_effect_definitions() {
}
/**
* Load the definition for an image effect.
* Loads the definition for an image effect.
*
* The effect definition is a set of core properties for an image effect, not
* containing any user-settings. The definition defines various functions to
......@@ -893,7 +896,7 @@ function image_effect_definition_load($effect) {
}
/**
* Load a single image effect.
* Loads a single image effect.
*
* @param $ieid
* The image effect ID.
......@@ -930,7 +933,7 @@ function image_effect_load($ieid, $style_name) {
}
/**
* Save an image effect.
* Saves an image effect.
*
* @param ImageStyle $style
* The image style this effect belongs to.
......@@ -959,7 +962,7 @@ function image_effect_save($style, &$effect) {
}
/**
* Delete an image effect.
* Deletes an image effect.
*
* @param ImageStyle $style
* The image style this effect belongs to.
......@@ -973,7 +976,7 @@ function image_effect_delete($style, $effect) {
}
/**
* Given an image object and effect, perform the effect on the file.
* Applies an image effect to the image object.
*
* @param $image
* An image object returned by image_load().
......@@ -1029,7 +1032,7 @@ function theme_image_style($variables) {
}
/**
* Accept a keyword (center, top, left, etc) and return it as a pixel offset.
* Accepts a keyword (center, top, left, etc) and returns it as a pixel offset.
*
* @param $value
* @param $current_pixels
......
......@@ -289,7 +289,7 @@ function node_title_list($result, $title = NULL) {
}
/**
* Decides on the type of marker to be displayed for a given node.
* Determines the type of marker to be displayed for a given node.
*
* @param $nid
* Node ID whose history supplies the "last viewed" timestamp.
......@@ -1087,7 +1087,7 @@ function node_is_page(Node $node) {
return (!empty($page_node) ? $page_node->nid == $node->nid : FALSE);
}
/**
/**
* Implements hook_preprocess_HOOK() for block.tpl.php.
*/
function node_preprocess_block(&$variables) {
......@@ -2139,9 +2139,9 @@ function node_feed($nids = FALSE, $channel = array()) {
return new Response($output, 200, array('Content-Type' => 'application/rss+xml; charset=utf-8'));
}
/**
* Generates an array for rendering the given node.
*
/**
* Generates an array for rendering the given node.
*
* @param Drupal\node\Node $node
* A node entity.
* @param $view_mode
......@@ -2436,8 +2436,8 @@ function node_search_validate($form, &$form_state) {
/**
* Implements hook_form_FORM_ID_alter().
*
* Alters System module's site information settings form to add a global default
* setting for number of posts to show on node listing pages.
* Alters the System module's site information settings form to add a global
* default setting for number of posts to show on node listing pages.
*
* @see node_page_default()
* @see taxonomy_term_page()
......@@ -3210,7 +3210,6 @@ function _node_access_rebuild_batch_finished($success, $results, $operations) {
* @} End of "defgroup node_access".
*/
/**
* @defgroup node_content Hook implementations for user-created content types
* @{
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment