Posted by rstamm on May 19, 2010 at 4:06pm
We don't have a standard doc header for implementations of themeable functions like THEME_process_HOOK and theme_breadcrumb.
my suggestion:
/**
* Implements THEME_process_HOOK().
*/
function garland_process_page(&$variables) {
//.../**
* Implements theme_breadcrumb().
*/
function garland_breadcrumb($variables) {
//...or
/**
* Overrides theme_breadcrumb().
*/
function garland_breadcrumb($variables) {
//...and simular to hook implementations, it is rather standard and does not require more explanation.
Comments
Yes we do.
We do have a standard, actually:
http://drupal.org/node/1354#themeable
Drupal programmer - http://poplarware.com
Drupal author - http://shop.oreilly.com/product/0636920034612.do
Drupal contributor - https://www.drupal.org/u/jhodgdon
no info on documenting overriding functions
hi jhodgdon,
the link you gave helps in learning how to document a theme function (eg: theme_breadcrumb()), but i think it does explain how to comment an OVERRIDING function (eg: garland_breadcrumb()).
maybe i need to search better... cheers! Pieter
True!
I think your suggestion of a one-liner saying "Overrides theme_whatever()" is a good one.
For hook implementations, you can follow this standard:
http://drupal.org/node/1354#hookimpl
Drupal programmer - http://poplarware.com
Drupal author - http://shop.oreilly.com/product/0636920034612.do
Drupal contributor - https://www.drupal.org/u/jhodgdon