api.module

Version 1.88.2.143 (checked in on 2010-07-01 at 23:54:46 by drumm)

Constants

NameDescription
API_RE_FILENAMERegular expression for matching file names.
API_RE_TAG_STARTRegular expression for starting inline @tags.

Functions

NameDescription
api_autocompletePrepares a listing of documentation objects for a branch.
api_blockImplementation of hook_block().
api_branch_sortSort callback for sorting branches.
api_class_childrenReturns class children with interfaces (recursive).
api_class_parentsReturns class parents and interfaces (recursive).
api_cronImplementation of hook_cron().
api_db_rewrite_sqlImplementation of hook_db_rewrite_sql().
api_filename_loadMenu object load callback for %api_filename in menu paths.
api_file_linkReturns a link to the file a documentation object is in.
api_filterImplementation of hook_filter().
api_filter_documentationTurns function names into links for filter.
api_get_active_branchReturns the currently active branch.
api_get_branchesReturns a list of all defined branches.
api_get_branch_namesReturns the list of currently-used branch names across all projects.
api_helpImplementation of hook_help().
api_hide_lHides a link for theme('api_expandable').
api_inheritedGet list of inherited members (recursive).
api_initImplementation of hook_init().
api_link_codeTurns function names into links in code.
api_link_documentationTurns function names into links in documentation.
api_link_linkTurns text into a link, using the first word as the object name.
api_link_nameLinks an object name to its documentation.
api_menuImplementation of hook_menu().
api_object_loadMenu object load callback for %api_object in menu paths.
api_object_title_and_breadcrumbSets the page title and breadcrumb for an object display page.
api_opensearchPage callback for path api/opensearch/[branch] - OpenSearch plugin.
api_page_branchPage callback for api/[branch]: displays the main documentation page.
api_page_classPage callback that displays documentation for a class.
api_page_constantPage callback that displays documentation for a constant.
api_page_filePage callback that displays documentation for a file.
api_page_file_sourcePage callback that displays source code for a file.
api_page_functionPage callback that displays documentation for a function.
api_page_function_dumpPage callback for path api/function_dump/[branch].
api_page_globalPage callback that displays documentation for a global.
api_page_groupPage callback that displays documentation for a group.
api_page_listingPage callback for displaying documentation for an object.
api_page_propertyPage callback that displays documentation for a global.
api_permImplementation of hook_perm().
api_preprocess_api_class_pageTheme preprocess function for api-global-page.tpl.php.
api_preprocess_api_constant_pageTheme preprocess function for api-constant-page.tpl.php.
api_preprocess_api_function_pageTheme preprocess function for api-function-page.tpl.php.
api_preprocess_api_global_pageTheme preprocess function for api-global-page.tpl.php.
api_preprocess_api_group_pageTheme preprocess function for api-group-page.tpl.php.
api_query_listSorts query result by object type.
api_related_topicsLists the topics (groups) that contain the documentation object.
api_render_class_hierarchyRender class hierarchy (recursive).
api_render_listingRenders an overview of documentation objects in a table.
api_save_branchSaves an API branch.
api_search_formForm builder for API search form.
api_search_form_submitForm submission handler for api_search_form().
api_search_listingPage callback for path api/search/[branch] -- performs a search.
api_search_redirectPage callback for path 'apis'.
api_show_lShows a link for theme('api_expandable').
api_splitSplits a string using a regular expression and processes the text using callbacks.
api_suggestPrepares a list of potential documentation matches for OpenSearch.
api_switch_projectReturns links to switch projects.
api_themeImplementation of hook_theme().
api_urlConstructs a link to an API object page.
_api_add_commentsRenders comments for a documentation object.
_api_link_documentationRecursive internal callback for turning function names into links in code.

Post new comment

  • Web page addresses and e-mail addresses turn into links automatically.
  • Allowed HTML tags: <a> <em> <strong> <cite> <code> <ul> <ol> <li> <dl> <dt> <dd>
  • Lines and paragraphs break automatically.

More information about formatting options