Because of its large size and prominence, the file common.inc will require its own patch for variable type hinting in the @param and @return directives. @webchick has indicated that this type of patch will not be backported to D7. This is also a lower priority patch to some of the other API documentation clean up work that is on-going.
The attached patch contains work in progress toward a complete patch for this issue.
#1331240: [Meta] Correct documentation for 'list' related issues
| Comment | File | Size | Author |
|---|---|---|---|
| #1 | Common_Variable_Type_Hinting-1333470-1.patch | 64.84 KB | lars toomre |
Comments
Comment #0.0
lars toomre commentedCorrects mis-use of
instead of tags.
Comment #1
lars toomre commentedAttached is work in progress about adding variable type hinting to all @param and @return directives in the large core file common.inc.
This work covers most of the functions. However, some @param and/or @return directives are missing that are being added in other 2011 API documentation sprint sub-issues #1310084: [meta] API documentation cleanup sprint.
There are also some questions about particular variable types that can be found by searching for '???' in the patch file.
One will need to check for completeness of coverage before final patch review for commitment.
Comment #2
thedavidmeister commented#1: Common_Variable_Type_Hinting-1333470-1.patch queued for re-testing.
Comment #3.0
(not verified) commentedAdded cross-reference to issue #1331240.
Comment #4
jhodgdonI'm closing very old coding standards fixup issues. They are being addressed on other issues mostly.