function ModuleBuilderGenerator::code_header in Module Builder 6.2

Return the file doxygen header and any custom header code.

1 call to ModuleBuilderGenerator::code_header()

ModuleBuilderGenerator::build in includes/generate.inc

The main code building function.

1 method overrides ModuleBuilderGenerator::code_header()

ModuleBuilderGeneratorInfo::code_header in includes/generate.inc

Override as info files have no header.

File

includes/generate.inc, line 79

Module builder code generating code.

Class

ModuleBuilderGenerator

Base class for code generators.

Code

function code_header() {
  $filename = $this->filename;
  $default = <<<EOT
/**
 * @file {<span class="php-variable">$filename</span>}
 * TODO: Enter file description here.
 */

EOT;
  $code = variable_get('module_builder_header', $default);
  return $code;
}