api-file-page.tpl.php

Version 1.1.2.7 (checked in on 2010-05-29 at 23:25:27 by drumm)

api-file-page.tpl.php Theme implementation for the summary page of a file.

Available variables:

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

Available variables in the $file object:

  • $file->title: Display name.
  • $file->summary: Short summary.
  • $file->documentation: HTML formatted comments.
  • $file->code: HTML formatted source code.
  • $file->objects: Documented objects HTML.
  • $file->see: Related api objects.

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