Add missing '$' character to docblock for timer_start(), timer_read(), and timer_stop() functions. [#1295502]

Attached patch fixes what I am sure are simple typographical errors:

--- a/includes/bootstrap.inc
+++ b/includes/bootstrap.inc
@@ -418,7 +418,7 @@ abstract class DrupalCacheArray implements ArrayAccess {
  * Start the timer with the specified name. If you start and stop the same
  * timer multiple times, the measured intervals will be accumulated.
  *
- * @param name
+ * @param $name
  *   The name of the timer.
  */
 function timer_start($name) {
@@ -431,7 +431,7 @@ function timer_start($name) {
 /**
  * Read the current timer value without stopping the timer.
  *
- * @param name
+ * @param $name
  *   The name of the timer.
  * @return
  *   The current timer value in ms.
@@ -454,7 +454,7 @@ function timer_read($name) {
 /**
  * Stop the timer with the specified name.
  *
- * @param name
+ * @param $name
  *   The name of the timer.
  * @return
  *   A timer array. The array contains the number of times the timer has been

Comment	File	Size	Author
#8	timer_foo-fix_docblock-1295502-8.patch	1.03 KB	pillarsdotnet
#8
#6	includes--bootstrap_inc-add_missing_dollar_sign.patch	960 bytes	pillarsdotnet
#6
#2	includes--bootstrap_inc-add_missing_dollar_signs-and-blank_lines.patch	3.24 KB	pillarsdotnet
#2
	includes--bootstrap_inc-add_missing_dollar_sign.patch	960 bytes	pillarsdotnet

Support from Acquia helps fund testing for Drupal Acquia logo

Comments

Comment #1

Lars Toomre CreditAttribution: Lars Toomre commented 30 September 2011 at 05:39

While you are in there, could you add a blank line before the @return doc statements? Thanks.

Comment #2

pillarsdotnet CreditAttribution: pillarsdotnet commented 30 September 2011 at 05:49

File	Size
includes--bootstrap_inc-add_missing_dollar_signs-and-blank_lines.patch	3.24 KB

@Lars Toomre

While you are in there, could you add a blank line before the @return doc statements?

Done, but now it probably won't get reviewed until after November 1st; sigh.

Comment #3

Lars Toomre CreditAttribution: Lars Toomre commented 30 September 2011 at 05:59

Thank you @pillarsdotnet. As is this looks good to go.

On a side note, do you know if the @param type hinting proposal for docblocks has been approved yet? If so, this patch includes a number of places where that type of docblock change also needs to be implemented.

Comment #4

pillarsdotnet CreditAttribution: pillarsdotnet commented 30 September 2011 at 06:07

@Lars Toomre

As is this looks good to go.

Feel free to RTBC; you're obviously qualified and this is a trivial docs-only change.

do you know if the @param type hinting proposal for docblocks has been approved yet?

You can join the discussion at Should all @param data types be documented?
And #1290258: The data type should be explicitly stated for all Drupal core @param and @return documentation.

Comment #5

jhodgdon

she/her

English

CreditAttribution: jhodgdon commented 30 September 2011 at 22:05

Status:

Needs review

» Needs work

PLEASE don't do a whole file at once, just do the functions mentioned in the issue (3 functions, not the whole file!!!!!!!). Then we can actually fix the doc that has problems.

Comment #6

pillarsdotnet CreditAttribution: pillarsdotnet commented 30 September 2011 at 22:40

Status:

Needs work

» Needs review

File	Size
includes--bootstrap_inc-add_missing_dollar_sign.patch	960 bytes

Whatever. Re-uploading the original patch. Y'all argue amongst yourselves as to which way you want it.

Comment #7

jhodgdon

she/her

English

CreditAttribution: jhodgdon commented 1 October 2011 at 00:12

Status:

Needs review

» Needs work

There's a sweet spot between fixing the blank line problems in the 3 functions named in the issue, and fixing the whole file...

Comment #8

pillarsdotnet CreditAttribution: pillarsdotnet commented 1 October 2011 at 00:22

Status:

Needs work

» Closed (won't fix)

File	Size
timer_foo-fix_docblock-1295502-8.patch	1.03 KB

Fine, but when I submit separate patches for each of the other functions, both you and webchick will complain. She's already complained about the fact that I submitted separate patches for separate files as I found similar problems in each.

I really wish y'all would reach a consensus on these things. And publish it somewhere so I can re-read it when I forget.

Comment #9

pillarsdotnet CreditAttribution: pillarsdotnet commented 1 October 2011 at 00:22

Status:

Closed (won't fix)

» Needs review

Comment #10

jhodgdon

she/her

English

CreditAttribution: jhodgdon commented 3 October 2011 at 15:30

Status:

Needs review

» Reviewed & tested by the community

See http://drupal.org/node/1295500#comment-5068622 regarding the consensus question. I do think that the ideas there represent consensus as in "how things have been going in the last year or two", and sorry they weren't written down somewhere for you.

Anyway, thanks, this patch is good to go for d7/8.