Task #34629

Clean up phpDoc comments in class template

Added by Sebastian Michaelsen about 1 year ago. Updated about 1 year ago.

Status:Resolved Start date:2012-03-07
Priority:Should have Due date:
Assignee:- % Done:

100%
Category:Code Cleanup
Target version:-
TYPO3 Version:4.7 Complexity:easy
PHP Version:
Votes: 0

Description

In analogy to #28087 I want to clean up the template class (typo3/template.php) this time. Clean phpDoc comments are important to make the API understandable to Users and IDEs.

So I made a patch doing mostly:

  • Provide correct parameter names in phpDoc
  • Provide correct data types in phpDoc
  • CGLify phpDoc (remove tabs)
  • CGLify method signatures (the first line of the method)
  • Corrected a few minor very obvious flaws ("$size = $size;" was my favorite)

Note on green bar feeling: After the patch the class is not green yet, but it has improved a lot. I'd like to tackle a few more flaws when this obvious changes are through.

Related issues

related to Core - Task #28087: Clean up phpDoc comments in t3lib_div Resolved 2011-07-11
related to Core - Bug #34882: Clean up phpDoc comments in t3lib_TStemplate Resolved 2012-03-15

Associated revisions

Revision a31b94a0
Added by Sebastian Michaelsen about 1 year ago

[TASK] Clean up phpDoc comments in class template

  • Provide correct parameter names in phpDoc
  • Provide correct data types in phpDoc
  • CGLify phpDoc (remove tabs)
  • CGLify method signatures (the first line of the method)
  • Corrected a few minor very obvious flaws

Change-Id: Ie474fe9009c73092b7323b06648eb2e988473cd9
Resolves: #34629
Releases: 6.0
Reviewed-on: http://review.typo3.org/9450
Reviewed-by: Christian Kuhn
Tested-by: Christian Kuhn

Revision 8f629b2a
Added by Sebastian Michaelsen 11 months ago

[TASK] Clean up phpDoc comments in class template

  • Provide correct parameter names in phpDoc
  • Provide correct data types in phpDoc
  • CGLify phpDoc (remove tabs)
  • CGLify method signatures (the first line of the method)
  • Corrected a few minor very obvious flaws

Change-Id: Ie474fe9009c73092b7323b06648eb2e988473cd9
Resolves: #34629
Releases: 6.0
Reviewed-on: http://review.typo3.org/9450
Reviewed-by: Christian Kuhn
Tested-by: Christian Kuhn

History

#1
Updated by Gerrit Code Review about 1 year ago

  • Status changed from New to Under Review

Patch set 1 for branch master has been pushed to the review server.
It is available at http://review.typo3.org/9450

#2
Updated by Gerrit Code Review about 1 year ago

Patch set 2 for branch master has been pushed to the review server.
It is available at http://review.typo3.org/9450

#3
Updated by Gerrit Code Review about 1 year ago

Patch set 3 for branch master has been pushed to the review server.
It is available at http://review.typo3.org/9450

#4
Updated by Gerrit Code Review about 1 year ago

Patch set 4 for branch master has been pushed to the review server.
It is available at http://review.typo3.org/9450

#5
Updated by Sebastian Michaelsen about 1 year ago

  • Status changed from Under Review to Resolved
  • % Done changed from 0 to 100

Also available in: Atom PDF