#1935970: Convert timer_* to a utility class and convert tests to phpunit introduced a couple of minor documentation bugs when it deprecated the timer_ functions.

The docblocks also do not include any information other than the @deprecated and @see. I checked https://drupal.org/node/1354#deprecated and it does not say that the documentation should be eliminated. On the one hand, I can see value in directing people entirely to the preferred function, but on the other, we've also retained the docblock in other places. We should update 1354 to clarify either that the rest of the docblock is still required, or add that it isn't if that's not the case.

CommentFileSizeAuthor
timer-docs.patch903 bytesxjm

Comments

jhodgdon’s picture

Status: Needs review » Needs work

@deprecated/@see should never be the only things in a doc block. These are pulled out of the documentation body during processing by the API module and the function will not have even a one-line description to list in api.drupal.org -- it will just be blank. I don't think this needs clarification on 1354 -- the general "everything needs a one-line description at least" still applies.

xjm’s picture

Issue summary: View changes
Issue tags: +Novice
sun’s picture

I'd recommend to close this in favor of #2173335: Remove deprecated timer_* functions

dermario’s picture

Status: Needs work » Closed (cannot reproduce)

I close this issue because the timer_* - functions do not exist in D8 any more.