Much of the function header doc (doxygen) is non-compliant with our current standards (see http://drupal.org/node/1354 for doxygen standards, and http://drupal.org/node/338208 for language/style/punctuation standards for documentation in general.)

For this issue, I've gone through functions actions.inc, bootstrap.inc, and batch.inc in the main "includes" directory of Drupal 7.x and fixed up the function headers -- patch coming shortly.

Corrections welcome. By the end of bootstrap.inc my brain was definitely hurting.

CommentFileSizeAuthor
#5 525596b.patch37.92 KBjhodgdon
#1 525596.patch36.5 KBjhodgdon

Comments

jhodgdon’s picture

jhodgdon
she/her
Primary language English
commented
Status: Active » Needs review
StatusFileSize
new 525596.patch36.5 KB

Here's the patch.

damien tournoud’s picture

damien tournoud commented
Status: Needs review » Needs work

Well, you changed the standard (which is pointless), so now you have to do the pointless job ;)

Two things that jumped at me when skimming through the patch:

 /**
- * Start the timer with the specified name. If you start and stop
+ * Starts the timer with the specified name. If you start and stop
  * the same timer multiple times, the measured intervals will be
  * accumulated.
  *

^ This looks like a very non standard header.

+/**
+ * Internal function: Actually perofrms the desired bootstrap phase.
+ */

^ I guess you mean "performs".

damien tournoud’s picture

damien tournoud commented
Category: bug » task

Reassigning.

jhodgdon’s picture

jhodgdon
she/her
Primary language English
commented

Thanks for the corrections, I'll fix the patch tomorrow.

[ignoring comments about pointlessness of task and task vs. bug report]

jhodgdon’s picture

jhodgdon
she/her
Primary language English
commented
Status: Needs work » Needs review
StatusFileSize
new 525596b.patch37.92 KB

Actually, here's a corrected patch.

Status: Needs review » Needs work

The last submitted patch failed testing.

jhodgdon’s picture

jhodgdon
she/her
Primary language English
commented
Status: Needs work » Needs review

Looks like the test bot was broken on that last test.

jhodgdon’s picture

jhodgdon
she/her
Primary language English
commented
Issue tags: +Novice

I think a novice could review this patch, after reading the coding standards referenced above. Only documentation headers are changing.

Status: Needs review » Needs work

The last submitted patch failed testing.

sun.core’s picture

sun.core commented
Status: Needs work » Needs review
jhodgdon’s picture

jhodgdon
she/her
Primary language English
commented
Status: Needs review » Closed (won't fix)

Apparently, no one cares about this but me, so I'm marking as "won't fix".