diff options
| author | Angie Byron <webchick@24967.no-reply.drupal.org> | 2009-07-01 17:34:13 +0000 |
|---|---|---|
| committer | Angie Byron <webchick@24967.no-reply.drupal.org> | 2009-07-01 17:34:13 +0000 |
| commit | d9ab38b2d02037e0af3916b1d99120389e9aadd9 (patch) | |
| tree | 9e48890ad1fa4b44706732a37537cc0d03191534 /includes/module.inc | |
| parent | b300a7a5936260bca7b0ec598cb1473814726f26 (diff) | |
| download | brdo-d9ab38b2d02037e0af3916b1d99120389e9aadd9.tar.gz brdo-d9ab38b2d02037e0af3916b1d99120389e9aadd9.tar.bz2 | |
#485350 by jhodgdon: Clarify documentation of module_load_include().
Diffstat (limited to 'includes/module.inc')
| -rw-r--r-- | includes/module.inc | 11 |
1 files changed, 10 insertions, 1 deletions
diff --git a/includes/module.inc b/includes/module.inc index ce8470962..3b79eee00 100644 --- a/includes/module.inc +++ b/includes/module.inc @@ -138,13 +138,22 @@ function module_load_install($module) { /** * Load a module include file. + * + * Examples: + * @code + * // Load node.admin.inc from the node module + * module_load_include('inc', 'node', 'node.admin'); + * // Load node.install from the node module + * module_load_include('install', 'node'); + * @endcode * * @param $type * The include file's type (file extension). * @param $module * The module to which the include file belongs. * @param $name - * Optionally, specify the file name. If not set, the module's name is used. + * Optionally, specify the base file name (without the $type extension). + * If not set, $module is used. */ function module_load_include($type, $module, $name = NULL) { if (empty($name)) { |