Task #28087

Clean up phpDoc comments in t3lib_div

Added by Sebastian Michaelsen over 8 years ago. Updated about 1 year ago.

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

100%

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_TStemplate Closed 2012-03-15
Related to TYPO3 Core - Task #34629: Clean up phpDoc comments in class template Closed 2012-03-07

Associated revisions

Revision 340a1316 (diff)
Added by Sebastian Michaelsen over 8 years ago

[TASK] Clean up phpDoc comments in t3lib_div

Clean phpDoc comments are important to make the API understandable to
users and IDEs. t3lib_div is a good point to start with.

Lots of comment changes to comply with CGL especially:
  • Provide the variable name in the @param line
  • Unify white spaces between @-command, datatype, varname and description
  • Correct wrong datatype declarations (default 0/1 to TRUE/FALSE for booleans)
  • Add some missing / incomplete phpDoc comments
  • Correct some spelling issues

Change-Id: I5265e172b5787a78b2598406eb40b8bcc68e07dc
Resolves: #28087
Releases: 4.6
Reviewed-on: http://review.typo3.org/3242
Reviewed-by: Christian Kuhn
Tested-by: Christian Kuhn

History

#1 Updated by Xavier Perseguers over 8 years ago

  • Status changed from New to Accepted

#2 Updated by Mr. Hudson over 8 years ago

Patch set 1 of change I5265e172b5787a78b2598406eb40b8bcc68e07dc has been pushed to the review server.
It is available at http://review.typo3.org/3242

#3 Updated by Mr. Hudson over 8 years ago

Patch set 2 of change I5265e172b5787a78b2598406eb40b8bcc68e07dc has been pushed to the review server.
It is available at http://review.typo3.org/3242

#4 Updated by Mr. Hudson over 8 years ago

Patch set 3 of change I5265e172b5787a78b2598406eb40b8bcc68e07dc has been pushed to the review server.
It is available at http://review.typo3.org/3242

#5 Updated by Mr. Hudson over 8 years ago

Patch set 4 of change I5265e172b5787a78b2598406eb40b8bcc68e07dc has been pushed to the review server.
It is available at http://review.typo3.org/3242

#6 Updated by Mr. Hudson over 8 years ago

Patch set 5 of change I5265e172b5787a78b2598406eb40b8bcc68e07dc has been pushed to the review server.
It is available at http://review.typo3.org/3242

#7 Updated by Mr. Hudson over 8 years ago

Patch set 6 of change I5265e172b5787a78b2598406eb40b8bcc68e07dc has been pushed to the review server.
It is available at http://review.typo3.org/3242

#8 Updated by Sebastian Michaelsen over 8 years ago

  • Status changed from Accepted to Resolved
  • % Done changed from 0 to 100

#9 Updated by Benni Mack about 1 year ago

  • Status changed from Resolved to Closed

Also available in: Atom PDF