function module_builder_code_hook_doxy in Module Builder 6.2

Same name and namespace in other branches

1. 7 includes/generate.inc \module_builder_code_hook_doxy()

Get the doxygen header for a given hook. This does not return with an initial newline so the doc block may be inserted into existing code.

Parameters

The long hook name, eg 'hook_menu'.:

1 call to module_builder_code_hook_doxy()

ModuleBuilderGeneratorCode::code_body in includes/generate.inc

Return the main body of the file code.

File

includes/generate.inc, line 343

Module builder code generating code.

Code

function module_builder_code_hook_doxy($hook_name) {
  return <<<EOT
/**
 * Implementation of {<span class="php-variable">$hook_name</span>}().
 */

EOT;
}