Come together with the global Drupal community in Rotterdam, 28 Sept – 1 Oct 2026. Sessions, contribution, connection, and Early Bird savings until 8 June.Druplicon periodically moans about function summaries not being on one line.
Sample:
Me: filter_xss?
Druplicon: filter_xss: [Documented summary is not one line. This is a bug. File a patch!] => filter_xss($string, $allowed_tags = array('a', 'em', 'strong', 'cite', 'code', 'ul', 'ol', 'li', 'dl', 'dt', 'dd')) => http://api.drupal.org/api/function/filter_xss/6
Me: filter_xss_bad_protocol?
Druplicon: filter_xss_bad_protocol: [Documented summary is not one line. This is a bug. File a patch!] => filter_xss_bad_protocol($string, $decode = TRUE) => http://api.drupal.org/api/function/filter_xss_bad_protocol/6
Me: _filter_autop?
Druplicon: _filter_autop: [Documented summary is not one line. This is a bug. File a patch!] => _filter_autop($text) => http://api.drupal.org/api/function/_filter_autop/6
All content from http://api.drupal.org/api/file/modules/filter/filter.module/6/source
The question now is:
Should the summary be on one line and we need to patch all those core occurences or should we disable Druplicons' complains?
Comments
Comment #1
morbus iffDruplicon is right. According to both the Doxygen style guidelines (and Coder Tough Love which, granted, I coded), Doxygen function summaries should be one line only. You're the first person in, jeez, six, eight, ten months, whose actually cared enough to create an issue. Thanks ;)
In short: yep, patch core.
Comment #2
morbus iffDruplicon is right. According to both the Doxygen style guidelines (and Coder Tough Love which, granted, I coded), Doxygen function summaries should be one line only. You're the first person in, jeez, six, eight, ten months, whose actually cared enough to create an issue. Thanks ;)
In short: yep, patch core.