Problem/Motivation

From #1315886: Clean up API docs for includes directory, files starting with A-C. There are missing @return for return values in the following files:

  • ajax.inc
  • batch.inc
  • bootstrap.inc
  • cache.inc
  • common.inc

Proposed resolution

Add @return for all return values except when it is explicitly not needed (per http://drupal.org/node/1354).

Remaining tasks

Postponed for #1326456: Add missing @param in includes A-C, plus other corrections to some docblocks.

Comments

xjm’s picture

xjm
she/her
Primary language English
commented
Title: Clean up API docs for [module or directory] » Add missing @return in includes A-C

Oops.

xjm’s picture

xjm
she/her
Primary language English
commented
Assigned: Unassigned » xjm
NROTC_Webmaster’s picture

NROTC_Webmaster commented
Status: Postponed » Active

Setting active since #1315886: Clean up API docs for includes directory, files starting with A-C is closed.

xjm’s picture

xjm
she/her
Primary language English
commented
Status: Active » Postponed

#1326456: Add missing @param in includes A-C, plus other corrections to some docblocks first.

xjm’s picture

xjm
she/her
Primary language English
commented
Assigned: xjm » Unassigned
xjm’s picture

xjm
she/her
Primary language English
commented
Issue summary: View changes

Updated issue summary.

jhodgdon’s picture

jhodgdon
she/her
Primary language English
commented
Issue summary: View changes
Status: Postponed » Closed (won't fix)

I'm closing very old coding standards fixup issues. They are being addressed on other issues mostly.