Commit 912b5513 authored by jhodgdon's avatar jhodgdon

Issue #1315992 by xjm: Remove path designations from menu callback docs to...

Issue #1315992 by xjm: Remove path designations from menu callback docs to conform with current 8.x standards
parent 3c78ca47
......@@ -351,8 +351,6 @@ function ajax_get_form() {
/**
* Page callback: Handles Ajax requests for the #ajax Form API property.
*
* Path: system/ajax
*
* This rebuilds the form from cache and invokes the defined #ajax['callback']
* to return an Ajax command structure for JavaScript. In case no 'callback' has
* been defined, nothing will happen.
......@@ -388,11 +386,6 @@ function ajax_form_callback() {
/**
* Theme callback: Returns the correct theme for an Ajax request.
*
* Paths:
* - system/ajax
* - file/ajax
* - file/progress
*
* Many different pages can invoke an Ajax request to system/ajax or another
* generic Ajax path. It is almost always desired for an Ajax response to be
* rendered using the same theme as the base page, because most themes are built
......
......@@ -8,8 +8,6 @@
/**
* Page callback: Displays the aggregator administration page.
*
* Path: admin/config/services/aggregator
*
* @see aggregator_menu()
*/
function aggregator_admin_overview() {
......@@ -59,8 +57,6 @@ function aggregator_view() {
/**
* Form constructor for adding and editing feed sources.
*
* Path: admin/config/services/aggregator/add/feed
*
* @param $feed
* If editing a feed, the feed to edit as a PHP stdClass value; if adding a
* new feed, NULL.
......@@ -215,8 +211,6 @@ function aggregator_form_feed_submit($form, &$form_state) {
/**
* Page callback: Deletes a feed.
*
* Path: admin/config/services/aggregator/remove/%aggregator_feed
*
* @param $feed
* An associative array describing the feed to be cleared.
*
......@@ -252,8 +246,6 @@ function aggregator_admin_remove_feed_submit($form, &$form_state) {
/**
* Form constructor for importing feeds from OPML.
*
* Path: admin/config/services/aggregator/add/opml
*
* @ingroup forms
* @see aggregator_menu()
* @see aggregator_form_opml_validate()
......@@ -413,8 +405,6 @@ function _aggregator_parse_opml($opml) {
/**
* Page callback: Refreshes a feed, then redirects to the overview page.
*
* Path: admin/config/services/aggregator/update/%aggregator_feed
*
* @param $feed
* An object describing the feed to be refreshed.
*
......@@ -431,8 +421,6 @@ function aggregator_admin_refresh_feed($feed) {
/**
* Form constructor for the aggregator system settings.
*
* Path: admin/config/services/aggregator/settings
*
* @see aggregator_menu()
* @see aggregator_admin_form_submit()
* @ingroup forms
......@@ -555,8 +543,6 @@ function aggregator_admin_form_submit($form, &$form_state) {
/**
* Form constructor to add/edit/delete aggregator categories.
*
* Path: admin/config/services/aggregator/add/category
*
* @param $edit
* An associative array containing:
* - title: A string to use for the category title.
......
......@@ -268,8 +268,6 @@ function aggregator_menu() {
/**
* Title callback: Returns a title for aggregatory category pages.
*
* Path: aggregator/categories/%aggregator_category
*
* @param $category
* An aggregator category.
*
......@@ -283,8 +281,6 @@ function _aggregator_category_title($category) {
/**
* Access callback: Determines whether there are any aggregator categories.
*
* Path: aggregator/categories
*
* @return
* TRUE if there is at least one category and the user has access to them;
* FALSE otherwise.
......
......@@ -8,8 +8,6 @@
/**
* Page callback: Displays the most recent items gathered from any feed.
*
* Path: aggregator
*
* @see aggregator_menu()
*/
function aggregator_page_last() {
......@@ -23,8 +21,6 @@ function aggregator_page_last() {
/**
* Page callback: Displays all the items captured from a particular feed.
*
* Path: aggregator/sources/%aggregator_feed
*
* @param $feed
* The feed for which to display all items.
*
......@@ -44,8 +40,6 @@ function aggregator_page_source($feed) {
/**
* Form constructor to show all items captured from a feed.
*
* Path: aggregator/sources/%aggregator_feed/categorize
*
* @param $feed
* The feed for which to list all the aggregated items.
*
......@@ -60,8 +54,6 @@ function aggregator_page_source_form($form, $form_state, $feed) {
/**
* Form constructor to list items aggregated in a category.
*
* Path: aggregator/categories
*
* @param $category
* The category for which to list all the aggregated items.
*
......@@ -81,8 +73,6 @@ function aggregator_page_category($category) {
/**
* Form constructor to list items aggregated in a category.
*
* Path: aggregator/categories/%aggregator_category/categorize
*
* @param $category
* The category for which to list all the aggregated items.
*
......@@ -342,8 +332,6 @@ function template_preprocess_aggregator_item(&$variables) {
/**
* Page callback: Displays all the feeds used by the aggregator.
*
* Path: aggregator/sources
*
* @see aggregator_menu()
*/
function aggregator_page_sources() {
......@@ -370,8 +358,6 @@ function aggregator_page_sources() {
/**
* Page callback: Displays all the categories used by the aggregator.
*
* Path: aggregator/categories
*
* @see aggregator_menu()
*/
function aggregator_page_categories() {
......@@ -396,8 +382,6 @@ function aggregator_page_categories() {
/**
* Page callback: Generates an RSS 0.92 feed of aggregator items or categories.
*
* Path: aggregator/rss
*
* @see aggregator_menu()
*/
function aggregator_page_rss() {
......@@ -468,8 +452,6 @@ function theme_aggregator_page_rss($variables) {
/**
* Page callback: Generates an OPML representation of all feeds.
*
* Path: aggregator/opml
*
* @param $cid
* If set, feeds are exported only from a category with this ID. Otherwise,
* all feeds are exported.
......
......@@ -8,8 +8,6 @@
/**
* Page callback: Attaches CSS for the block region demo.
*
* Path: admin/structure/block/demo/% (for each theme)
*
* @see block_menu()
*/
function block_admin_demo($theme = NULL) {
......@@ -20,8 +18,6 @@ function block_admin_demo($theme = NULL) {
/**
* Page callback: Shows the block administration page.
*
* Path: admin/structure/block
*
* @param $theme
* The theme to display the administration page for. If not provided, defaults
* to the currently used theme.
......@@ -257,8 +253,6 @@ function _block_compare($a, $b) {
/**
* Form constructor for the block configuration form.
*
* Path: admin/structure/block/manage/%/%
*
* Also used by block_add_block_form() for adding a new custom block.
*
* @param $module
......@@ -539,8 +533,6 @@ function block_admin_configure_submit($form, &$form_state) {
/**
* Form constructor for the add block form.
*
* Path: admin/structure/block/add
*
* @see block_menu()
* @see block_add_block_form_validate()
* @see block_add_block_form_submit()
......@@ -632,8 +624,6 @@ function block_add_block_form_submit($form, &$form_state) {
/**
* Form constructor for the custom block deletion form.
*
* Path: admin/structure/block/manage/%/%/delete
*
* @param $module
* The name of the module that implements the block to be deleted. This should
* always equal 'block' since it only allows custom blocks to be deleted.
......
......@@ -195,8 +195,6 @@ function _block_themes_access($theme) {
/**
* Theme callback: Uses the theme specified in the parameter.
*
* Path: admin/structure/block/demo/% (for each theme)
*
* @param $theme
* The theme whose blocks are being configured. If not set, the default theme
* is assumed.
......
......@@ -8,8 +8,6 @@
/**
* Page callback: Returns an administrative overview of all books.
*
* Path: admin/content/book
*
* @see book_menu()
*/
function book_admin_overview() {
......@@ -28,8 +26,6 @@ function book_admin_overview() {
/**
* Form constructor for the book settings form.
*
* Path: admin/content/book/settings
*
* @see book_menu()
* @see book_admin_settings_validate()
* @ingroup forms
......@@ -70,8 +66,6 @@ function book_admin_settings_validate($form, &$form_state) {
/**
* Form constructor for administering a single book's hierarchy.
*
* Path: admin/content/book/%node
*
* @param $node
* The node of the top-level page in the book.
*
......
......@@ -213,8 +213,6 @@ function _book_outline_access($node) {
/**
* Access callback: Determines if the user can remove nodes from the outline.
*
* Path: node/%node/outline/remove
*
* @param $node
* The node to remove from the outline.
*
......
......@@ -8,8 +8,6 @@
/**
* Page callback: Prints a listing of all books.
*
* Path: book
*
* @see book_menu()
*/
function book_render() {
......@@ -24,8 +22,6 @@ function book_render() {
/**
* Page callback: Generates representations of a book page and its children.
*
* Path: book/export/%/%
*
* The function delegates the generation of output to helper functions. The
* function name is derived by prepending 'book_export_' to the given output
* type. So, e.g., a type of 'html' results in a call to the function
......@@ -97,8 +93,6 @@ function book_export_html($nid) {
/**
* Page callback: Shows the outline form for a single node.
*
* Path: node/%node/outline
*
* @param $node
* The book node for which to show the outline.
*
......@@ -203,8 +197,6 @@ function book_outline_form_submit($form, &$form_state) {
/**
* Form constructor to confirm removal of a node from a book.
*
* Path: node/%node/outline/remove
*
* @param $node
* The node to delete.
*
......
......@@ -8,8 +8,6 @@
/**
* Page callback: Presents an administrative comment listing.
*
* Path: admin/content/comment
*
* @param $type
* The type of the overview form ('approval' or 'new'). See
* comment_admin_overview() for details.
......@@ -250,8 +248,6 @@ function comment_multiple_delete_confirm_submit($form, &$form_state) {
/**
* Page callback: Shows a confirmation page for comment deletions.
*
* Path: comment/%/delete
*
* @param $cid
* The ID of the comment that is about to be deleted.
*
......
......@@ -1643,8 +1643,6 @@ function comment_get_display_page($cid, $node_type) {
/**
* Page callback: Displays the comment editing form.
*
* Path: comment/%comment/edit
*
* @param $comment
* The comment object representing the comment to be edited.
*
......
......@@ -102,8 +102,6 @@ function comment_reply($node, $pid = NULL) {
/**
* Page callback: Publishes the specified comment.
*
* Path: comment/%/approve
*
* @param $cid
* A comment identifier.
*
......
......@@ -8,8 +8,6 @@
/**
* Page callback: Lists contact categories.
*
* Path: admin/structure/contact
*
* @see contact_menu()
*/
function contact_category_list() {
......@@ -59,10 +57,6 @@ function contact_category_list() {
/**
* Form constructor for the category edit form.
*
* Paths:
* - admin/structure/contact/add
* - admin/structure/contact/edit/%contact
*
* @param $category
* An array describing the category to be edited. May be empty for new
* categories. Recognized array keys are:
......@@ -197,8 +191,6 @@ function contact_category_edit_form_submit($form, &$form_state) {
/**
* Form constructor for the contact category deletion form.
*
* Path: admin/structure/contact/delete/%contact
*
* @param $contact
* Array describing the contact category to be deleted. See the documentation
* of contact_category_edit_form() for the recognized keys.
......
......@@ -109,8 +109,6 @@ function contact_menu() {
/**
* Access callback: Checks access for a user's personal contact form.
*
* Path: user/%user/contact
*
* @param $account
* The user object of the user whose contact form is being requested.
*
......
......@@ -8,8 +8,6 @@
/**
* Form constructor for the site-wide contact form.
*
* Path: contact
*
* @see contact_menu()
* @see contact_site_form_validate()
* @see contact_site_form_submit()
......@@ -176,8 +174,6 @@ function contact_site_form_submit($form, &$form_state) {
/**
* Form constructor for the personal contact form.
*
* Path: user/%user/contact
*
* @see contact_menu()
* @see contact_personal_form_validate()
* @see contact_personal_form_submit()
......
......@@ -8,8 +8,6 @@
/**
* Page callback: Lists all defined fields for quick reference.
*
* Path: admin/reports/fields
*
* @see field_ui_menu()
*/
function field_ui_fields_list() {
......@@ -287,9 +285,6 @@ function theme_field_ui_table($variables) {
/**
* Form constructor for the 'Manage fields' form of a bundle.
*
* Path: BUNDLE_ADMIN_PATH/fields, where BUNDLE_ADMIN_PATH is the path stored in
* the ['admin']['info'] property in the return value of hook_entity_info().
*
* The resulting form allows fields and pseudo-fields to be re-ordered.
*
* @see field_ui_menu()
......@@ -880,12 +875,6 @@ function field_ui_field_overview_form_submit($form, &$form_state) {
/**
* Form constructor for the field display settings for a given view mode.
*
* Paths:
* - BUNDLE_ADMIN_PATH/display
* - BUNLDE_ADMIN_PATH/display/%view_mode
* where BUNDLE_ADMIN_PATH is the path stored in the ['admin']['info'] property
* in the return value of hook_entity_info().
*
* @see field_ui_menu()
* @see field_ui_display_overview_multistep_submit()
* @see field_ui_display_overview_form_submit()
......@@ -1568,10 +1557,6 @@ function field_ui_existing_field_options($entity_type, $bundle) {
/**
* Form constructor for the field settings edit page.
*
* Path: BUNDLE_ADMIN_PATH/fields/%field/field-settings, where BUNDLE_ADMIN_PATH
* is the path stored in the ['admin']['info'] property
* in the return value of hook_entity_info().
*
* @see field_ui_menu()
* @see field_ui_settings_form_submit()
* @ingroups forms
......@@ -1657,10 +1642,6 @@ function field_ui_field_settings_form_submit($form, &$form_state) {
/**
* Form constructor for the widget selection form.
*
* Path: BUNDLE_ADMIN_PATH/fields/%field/widget-type, where BUNDLE_ADMIN_PATH is
* the path stored in the ['admin']['info'] property in the return value of
* hook_entity_info().
*
* @see field_ui_menu()
* @see field_ui_widget_type_form_submit()
* @ingroup forms
......@@ -1739,10 +1720,6 @@ function field_ui_widget_type_form_submit($form, &$form_state) {
/**
* Form constructor for removing a field instance from a bundle.
*
* Path: BUNDLE_ADMIN_PATH/fields/%field/delete, where BUNDLE_ADMIN_PATH is the
* path stored in the ['admin']['info'] property in the return value of
* hook_entity_info().
*
* @see field_ui_menu()
* @see field_ui_field_delete_form_submit()
* @ingroup forms
......@@ -1814,12 +1791,6 @@ function field_ui_field_delete_form_submit($form, &$form_state) {
/**
* Form constructor for the field instance settings form.
*
* Paths:
* - BUNDLE_ADMIN_PATH/fields/%field
* - BUNDLE_ADMIN_PATH/fields/%field/edit
* where BUNDLE_ADMIN_PATH is the path stored in the ['admin']['info'] property
* in the return value of hook_entity_info().
*
* @see field_ui_menu()
* @see field_ui_field_edit_form_validate()
* @see field_ui_field_edit_form_submit()
......
......@@ -239,10 +239,6 @@ function field_ui_menu_load($field_name, $entity_type, $bundle_name, $bundle_pos
/**
* Title callback: Returns the name of a given instance.
*
* Path: BUNDLE_ADMIN_PATH/fields/%field, where BUNDLE_ADMIN_PATH is the path
* stored in the ['admin']['info'] property in the return value of
* hook_entity_info().
*
* @see field_ui_menu()
*/
function field_ui_menu_title($instance) {
......@@ -252,9 +248,6 @@ function field_ui_menu_title($instance) {
/**
* Access callback: Checks access for the 'view mode display settings' pages.
*
* Path: BUNDLE_ADMIN_PATH/display, where BUNDLE_ADMIN_PATH is the path stored
* in the ['admin']['info'] property in the return value of hook_entity_info().
*
* @see field_ui_menu()
*/
function _field_ui_view_mode_menu_access($entity_type, $bundle, $view_mode, $access_callback) {
......
......@@ -225,8 +225,6 @@ function file_file_download($uri, $field_type = 'file') {
/**
* Ajax callback: Processes file uploads and deletions.
*
* Path: file/ajax
*
* This rebuilds the form element for a particular field item. As long as the
* form processing is properly encapsulated in the widget element the form
* should rebuild correctly using FAPI without the need for additional callbacks
......@@ -292,8 +290,6 @@ function file_ajax_upload() {
/**
* Ajax callback: Retrieves upload progress.
*
* Path: file/progress
*
* @param $key
* The unique key for this upload process.
*/
......
......@@ -24,8 +24,6 @@ function file_module_test_menu() {
/**
* Form constructor for testing a 'managed_file' element.
*
* Path: file/test
*
* @see file_module_test_menu()
* @see file_module_test_form_submit()
* @ingroup forms
......
......@@ -8,8 +8,6 @@
/**
* Page callback: Prints a page listing a glossary of Drupal terminology.
*
* Path: admin/help
*
* @see help_menu()
*/
function help_main() {
......@@ -22,8 +20,6 @@ function help_main() {
/**
* Page callback: Prints a page listing general help for a module.
*
* Path: admin/help/%
*
* @param $name
* A module name to display a help page for.
*
......
......@@ -8,8 +8,6 @@
/**
* Page callback: Displays the content type admin overview page.
*
* Path: admin/structure/types
*
* @see node_menu()
*/
function node_overview_types() {
......@@ -423,8 +421,6 @@ function node_type_reset($type) {
/**
* Page callback: Form constructor for the content type delete form.
*
* Path: admin/structure/types/manage/%node_type/delete
*
* @param $type
* Content type object.
*
......
......@@ -8,8 +8,6 @@
/**
* Page callback: Form constructor for the permission rebuild confirmation form.
*
* Path: admin/reports/status/rebuild
*
* @see node_menu()
* @see node_configure_rebuild_confirm_submit()
*/
......@@ -372,8 +370,6 @@ function _node_mass_update_batch_finished($success, $results, $operations) {
/**
* Page callback: Form constructor for the content administration form.
*
* Path: admin/content
*
* @see node_multiple_delete_confirm()
* @see node_multiple_delete_confirm_submit()
* @see node_admin_nodes()
......
......@@ -1447,8 +1447,6 @@ function node_build_content($node, $view_mode = 'full', $langcode = NULL) {
/**
* Page callback: Generates an array which displays a node detail page.
*
* Path: node/%node/revisions/%/view
*
* @param $node
* A node object.
* @param $message
......@@ -1906,12 +1904,6 @@ function theme_node_search_admin($variables) {
/**
* Access callback: Checks node revision access.
*
* Paths:
* - node/%node/revisions
* - node/%node/revisions/%/view
* - node/%node/revisions/%/revert
* - node/%node/revisions/%/delete
*
* @param $node
* The node to check.
* @param $op
......@@ -1959,8 +1951,6 @@ function _node_revision_access($node, $op = 'view') {
/**
* Access callback: Checks whether the user has permission to add a node.
*
* Paths: node/add
*
* @return
* TRUE if the user has permission, otherwise FALSE.
*
......@@ -2182,8 +2172,6 @@ function node_menu_local_tasks_alter(&$data, $router_item, $root_path) {
/**
* Title callback: Provides the title for a node type edit form.
*
* Path: admin/structure/types/manage/%node_type
*
* @param $type
* The node type object.
*
......@@ -2196,8 +2184,6 @@ function node_type_page_title($type) {
/**
* Title callback: Displays the node's title.
*
* Path: node/%node
*
* @param $node
* The node object.
*
......@@ -2562,8 +2548,6 @@ function node_block_list_alter(&$blocks) {
/**
* Page callback: Generates and prints an RSS feed.
*
* Path: rss.xml
*
* Generates an RSS feed from an array of node IDs, and prints it with an HTTP
* header, with Content Type set to RSS/XML.
*
......@@ -2682,8 +2666,6 @@ function node_view_multiple($nodes, $view_mode = 'teaser', $weight = 0, $langcod
/**
* Page callback: Generates a listing of promoted nodes.
*
* Path: node
*
* @see node_menu()
*/
function node_page_default() {
......@@ -2736,8 +2718,6 @@ function node_page_default() {
/**
* Page callback: Displays a single node.
*
* Path: node/%node
*
* @param $node
* The node object.
*
......@@ -2988,12 +2968,6 @@ function node_form_system_themes_admin_form_submit($form, &$form_state) {
/**
* Access callback: Checks a user's permission for performing a node operation.
*
* Paths:
* - node/%node
* - node/%node/edit
* - node/%node/delete
* - 'node/add/' . $type_url_str (part of foreach)
*
* @param $op
* The operation to be performed on the node. Possible values are:
* - "view"
......
......@@ -13,8 +13,6 @@
/**
* Page callback: Presents the node editing form.
*
* Path: node/%node/edit
*
* @see node_menu()
*/
function node_page_edit($node) {
......@@ -26,8 +24,6 @@ function node_page_edit($node) {
/**
* Page callback: Presents the node add form.
*
* Path: node/add
*