http://api.drupal.org/api/function/l

If the possible keys for the $options parameter were turned into a bullet list, it would hugely improve readability.

CommentFileSizeAuthor
#1 bulletize-options-param-keys-in-common.inc_.patch1.48 KBmeitar

Comments

meitar’s picture

meitar commented
StatusFileSize
new bulletize-options-param-keys-in-common.inc_.patch1.48 KB

This appears to be fixed in CVS HEAD already, and is live for Drupal 7. However, it's not for prior versions of Drupal, with the worst offender being Drupal 6 (in which the text just runs in a single long line).

Attached to this comment is a diff -u patch to the includes/common.inc file where this function is defined (from Drupal 6.2's official release) with the appropriate Doxygen changes made to make the $options parameter into a bulleted list (I hope).

Not sure if this will get applied since it's already fixed in CVS HEAD, but Drupal 6 is the current version of Drupal and applying this patch would certainly help readability, as the original submitter notes above.

steven jones’s picture

steven jones commented
Project: Documentation » Drupal core
Version: » 6.x-dev
Component: Documentation in CVS » documentation

Putting in the right issue queue. Will check the patch over in the morning unless someone else wants to?

steven jones’s picture

steven jones commented
Status: Active » Closed (duplicate)

Duplicate of #258475: Make doxygen docs clearer for l()