Calling all Drupal developers!
Help us get this on the first page of Digg. DIGG NOW!
Contributions API
Search Drupal 5
Modules in 5
- acl
- admin_menu
- amfphp
- api
- asset
- asset_bonus
- asset_emfield
- asset_import
- asset_panels
- asset_search
- asset_wizard
- audiofield
- auto_nodetitle
- avatar_selection
- bueditor
- calais
- calais_api
- calais_geo
- calais_tagmods
- calendar
- calendar_ical
- captcha
- cck_field_perms
- cclinks
- coder
- commit_restrictions
- commitlog
- contemplate
- content
- content_access
- content_copy
- custom_breadcrumbs
- cvs_deploy
- date
- date_api
- date_copy
- demo
- dependent
- devel
- devel_generate
- devel_node_access
- diggthis
- domain
- domain_conf
- domain_content
- domain_nav
- domain_prefix
- domain_source
- domain_strict
- domain_theme
- domain_user
- domain_views
- drush
- drush_pm
- drush_pm_cvs
- drush_pm_wget
- drush_sql
- drush_tools
- editablefields
- elf
- emaudio
- emfield
- emimport
- emthumb
- faq
- fckeditor
- fieldgroup
- file_import
- filefield
- fivestar
- forward
- fquery
- genericplayers
- globalredirect
- gmap
- gmap_location
- gmap_macro_builder
- gmap_taxonomy
- gmap_views
- googleanalytics
- hierarchical_select
- i18n
- i18nblocks
- i18ncontent
- i18nmenu
- i18nprofile
- i18nstrings
- i18nsync
- i18ntaxonomy
- i18nviews
- image
- image_attach
- image_captcha
- image_gallery
- image_im_advanced
- image_import
- image_ncck
- imageapi
- imageapi_gd
- imageapi_imagemagick
- imagecache
- imagecache_ui
- imagefield
- install_profile_wizard
- javascript_aggregator
- jquery_plugin
- jquery_update
- lightbox2
- link
- lutman
- macro
- module_builder
- moduleweight
- mollom
- mp_file
- mp_notify
- mp_orders
- mp_products
- mp_reports
- mp_shipping
- node_service
- nodefamily
- nodeprofile
- nodereference
- number
- og
- og_panels
- onepixelout
- optionwidgets
- page_title
- pageroute
- pageroute_nodefamily
- pageroute_ui
- path_redirect
- pathauto
- patterns
- pingback
- poormanscron
- project
- project_issue
- project_issue_generate
- project_release
- project_usage
- render
- search_service
- sections
- securepages
- service_links
- services
- shadowbox
- simpletest
- simpletest_xmlrpc
- simpleviewer
- states
- swfobject
- swftools
- swftools_integrate
- system_service
- tagadelic
- tapir
- taxonomy_service
- teleport
- test_gateway
- text
- text_captcha
- token
- trackback
- translation
- transliteration
- ttext
- ubrowser
- uc_2checkout
- uc_attribute
- uc_authorizenet
- uc_cart
- uc_cart_links
- uc_catalog
- uc_credit
- uc_cybersource
- uc_file
- uc_flatrate
- uc_googleanalytics
- uc_importer
- uc_notify
- uc_order
- uc_payment
- uc_payment_pack
- uc_paypal
- uc_product
- uc_product_kit
- uc_quote
- uc_recurring
- uc_repeater
- uc_reports
- uc_roles
- uc_shipping
- uc_stock
- uc_store
- uc_taxes
- uc_ups
- uc_usps
- uc_weightquote
- ufo
- update_status
- user_service
- userreference
- versioncontrol
- versioncontrol_account_status
- versioncontrol_fakevcs
- vfs_ranking_nodetype
- video_cck
- videofield
- views
- views_bonus_archive
- views_bonus_audio_playlist
- views_bonus_bare
- views_bonus_export
- views_bonus_glob
- views_bonus_grid
- views_bonus_lineage_tree
- views_bonus_panels
- views_bonus_sparkline
- views_bonus_summary_combo
- views_fastsearch
- views_rss
- views_service
- views_slideshow
- views_theme_wizard
- views_ui
- webform
- wijering
- workflow_ng
- workflow_ng_ui
- xmlrpc_server
- xmlsitemap
- xmlsitemap_engines
- xmlsitemap_node
- xmlsitemap_term
- xmlsitemap_user
api.module
Version
1.48.2.21 (checked in on 2008/01/26 at 03:34:44 by drumm)
Description
Generates and displays API documentation pages.
This is an implementation of a subset of the Doxygen documentation generator specification, tuned to produce output that best benefits the Drupal code base. It is designed to assume the code it documents follows Drupal coding conventions, and supports the following Doxygen constructs: @ mainpage @ file @ defgroup @ ingroup @ addtogroup (as a synonym of @ ingroup) @ param @ return @ link
Constants
Name | Description |
|---|---|
| API_RE_FILENAME | Regular expression for matching file names. |
Functions
| Name | Description |
|---|---|
| api_autocomplete | Prepare a listing of potential documentation matches for a branch. |
| api_block | |
| api_cron | Implementation of hook_cron(). |
| api_get_active_branch | |
| api_get_branches | |
| api_help | Implementation of hook_help() |
| api_link_code | Turn function names into links. |
| api_link_documentation | Turn function and file names into links. This is done on output because the identifiers which are linked frequently change. |
| api_link_name | Link an object name to its documentation. |
| api_menu | Implementation of hook_menu(). |
| api_page_admin | Menu callback; displays the administration page. |
| api_page_admin_form | |
| api_page_admin_form_submit | |
| api_page_branch | Menu callback; displays the main documentation page. |
| api_page_constant | Menu callback; displays documentation for a constant. |
| api_page_file | Menu callback; displays documentation for a file. |
| api_page_file_source | Menu callback; displays source code for a file. |
| api_page_function | Menu callback; displays documentation for a function. |
| api_page_function_dump | Menu callback; produces a textual listing of all functions for use in IDEs. |
| api_page_function_references | Menu callback; displays all functions that reference another function. |
| api_page_global | Menu callback; displays documentation for a global. |
| api_page_group | Menu callback; displays documentation for a group. |
| api_page_listing | Menu callback; displays an object listing. |
| api_perm | Implementation of hook_perm(). |
| api_php_manual_index_form | |
| api_php_manual_index_form_submit | |
| api_reindex_form | |
| api_reindex_form_submit | |
| api_render_listing | Render a table with an overview of documentation objects. |
| api_scan_directories | Find all the files in the directories specified for a branch. |
| api_search_form | |
| api_search_form_submit | |
| api_search_listing | Menu callback; perform a global search for documentation. |
| api_simpletest | |
| api_split | Split a string using a regular expression and process the text using callbacks. |
| _api_link_documentation | |
| _api_listing_headers |