Coding standards: Data types in param/return docs

By jhodgdon on 17 October 2011

Change record status:

Published (View all published change records)

Project:

Drupal core

Introduced in branch:

8.x

Issue links:

https://www.drupal.org/node/711918

Description:

The coding standards for documentation blocks were updated, to strongly recommend (and in some cases require) that data types be included in parameter and return value documentation. Example:

 * @param string $description
 *   Description of this parameter, which takes a string.
 *
 * @return string
 *   Description of the return value, which is a string.

See http://drupal.org/node/1354#functions for more details on the coding/documentation standard.

Impacts:

Module developers

Updates Done (doc team, etc.)

Online documentation:

Generic online documentation done

Theming guide:

Not done

Module developer documentation:

Module developer documentation done

Examples project:

Not done