Issue Task Closed

#28087Clean up phpDoc comments in t3lib_div

Sebastian Michaelsen 07/11/11, 11:21 updated 10/02/18, 12:37

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.

Reviews 1