Task #34629

Clean up phpDoc comments in class template

Added by Sebastian Michaelsen over 9 years ago. Updated about 3 years ago.

Status:
Closed
Priority:
Should have
Assignee:
-
Category:
Code Cleanup
Target version:
-
Start date:
2012-03-07
Due date:
% Done:

100%

Estimated time:
TYPO3 Version:
4.7
PHP Version:
Tags:
Complexity:
easy
Sprint Focus:

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 TYPO3 Core - Bug #34882: Clean up phpDoc comments in t3lib_TStemplateClosed2012-03-15

Actions
Related to TYPO3 Core - Task #28087: Clean up phpDoc comments in t3lib_divClosed2011-07-11

Actions

Also available in: Atom PDF