api-defined.tpl.php

Version 1.1.2.4 (checked in on 2010-04-21 at 23:21:12 by drumm)

api-defined.tpl.php Theme implementation to show which object an api object is defined in.

Available variables:

  • $documentation: Documentation from the comment header of the constant.
  • $branch: Object with information about the branch.
  • $object: Object with information about the constant.
  • $is_admin: True or false.
  • $logged_in: True or false.

Available variables in the $branch object:

  • $branch->project: The machine name of the branch.
  • $branch->title: A proper title for the branch.
  • $branch->directories: The local included directories.
  • $branch->excluded_directories: The local excluded directories.

Available variables in the definition $object.

  • $object->title: Display name.
  • $object->summary: Short summary.
  • $object->documentation: HTML formatted comments.
  • $object->code: HTML formatted source 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