api_link_documentation

Versions
6: api_link_documentation($documentation, $branch, $class_did = NULL, $aggressive_classes = FALSE)

Turns function names into links in documentation.

Parameters

$documentation Documentation to scan for function names.

$branch Branch to make the links in.

$aggressive_classes Try linking every word with a capital letter to a class or interface.

Return value

Documentation with function names formatted as links.

▸ 10 functions call api_link_documentation()

▾ 10 functions call api_link_documentation()

api_page_branch in contrib-6/api/api.module: Page callback for api/[branch]: displays the main documentation page.
api_page_class in contrib-6/api/api.module: Page callback that displays documentation for a class.
api_page_constant in contrib-6/api/api.module: Page callback that displays documentation for a constant.
api_page_file in contrib-6/api/api.module: Page callback that displays documentation for a file.
api_page_function in contrib-6/api/api.module: Page callback that displays documentation for a function.
api_page_global in contrib-6/api/api.module: Page callback that displays documentation for a global.
api_page_group in contrib-6/api/api.module: Page callback that displays documentation for a group.
api_page_property in contrib-6/api/api.module: Page callback that displays documentation for a global.
api_related_topics in contrib-6/api/api.module: Lists the topics (groups) that contain the documentation object.
api_render_listing in contrib-6/api/api.module: Renders an overview of documentation objects in a table.

Code

contrib-6/api/api.module, line 1774

<?php
function api_link_documentation($documentation, $branch, $class_did = NULL, $aggressive_classes = FALSE) {
  return _filter_url(api_filter_documentation($documentation, $branch, $class_did, $aggressive_classes), NULL);
}
?>

Drupal e-Commerce API

Search Drupal 6.x

Navigation