Task #28087

Clean up phpDoc comments in t3lib_div

Added by Sebastian Michaelsen almost 10 years ago. Updated over 2 years ago.

Status:
Closed
Priority:
Should have
Assignee:
-
Category:
-
Target version:
-
Start date:
2011-07-11
Due date:
% Done:

100%

Estimated time:
TYPO3 Version:
4.6
PHP Version:
Tags:
Complexity:
Sprint Focus:

Description

It's time for some cleanup. Clean phpDoc comments are important to make the API understandable to Users and IDEs. I think t3lib_div is a good point to start with.

Here is what I intent to do with this RFC:
     * @param        string  Number of hex charactres to return
  • Provide the variable name in the @param line (complies CGL)
  • Unify whitespaces between @-command, datatype, varname and description (a single space between each of them, complies CGL)
  • Correct wrong datatype declarations where it makes sense
  • Correct spelling issues where I stumble over them
     * @param integer $count Number of hex characters to return

I already got the patch, I'll submit it shortly.


Related issues

Related to TYPO3 Core - Bug #34882: Clean up phpDoc comments in t3lib_TStemplateClosed2012-03-15

Actions
Related to TYPO3 Core - Task #34629: Clean up phpDoc comments in class templateClosed2012-03-07

Actions

Also available in: Atom PDF