Review main Merged

12297[TASK] Clean up phpDoc comments in typo3/sysext/

Wouter Wolters CR +2 V +2 Hard +233 −196 updated 06/03/13, 20:49

Commit message

Clean up phpDoc comments for the following classes:

* typo3/sysext/recordlist/ext_tables.php
* typo3/sysext/recordlist/mod1/index.php
* typo3/sysext/reports/ext_localconf.php
* typo3/sysext/reports/ext_tables.php
* typo3/sysext/reports/interfaces/interface.tx_reports_report.php
* typo3/sysext/reports/interfaces/interface.tx_reports_statusprovider.php
* typo3/sysext/reports/mod/index.php
* typo3/sysext/reports/reports/class.tx_reports_reports_status.php
* typo3/sysext/reports/reports/status/
class.tx_reports_reports_status_configurationstatus.php
* typo3/sysext/reports/reports/status/
class.tx_reports_reports_status_securitystatus.php
* typo3/sysext/reports/reports/status/
class.tx_reports_reports_status_status.php
* typo3/sysext/reports/reports/status/
class.tx_reports_reports_status_systemstatus.php
* typo3/sysext/reports/reports/status/
class.tx_reports_reports_status_typo3status.php
* typo3/sysext/reports/reports/status/
class.tx_reports_reports_status_warningmessagepostprocessor.php
* typo3/sysext/reports/tasks/
class.tx_reports_tasks_systemstatusupdatetask.php
* typo3/sysext/reports/tasks/
class.tx_reports_tasks_systemstatusupdatetasknotificationemailfield.php

Clean up provides:

* Provide correct parameter names in phpDoc
* Provide correct data types in phpDoc
* CGLify phpDoc (remove tabs)

Review

  • Code review CR +2
    • Christian Kuhn +2
  • Verified V +2
    • Christian Kuhn +2

Issues 1

Files 16

Review log 6

  1. Oliver Klee commented on patch set 1 06/22/12, 17:52

    I would prefer that you didn't submit this

    class.tx_reports_reports_status.php:35

    @var for fields do not need the field name, just the type and an (optional) description

    class.tx_reports_reports_status_configurationstatus.php:37

    @var for fields do not need the field name, just the type and an (optional) description.Ditto for the other fields.

    class.tx_reports_reports_status_status.php:42

    @var for fields do not need the field name, just the type and an (optional) description.Ditto for the other fields.

    class.tx_reports_reports_status_systemstatus.php:38

    for fields, the field name is not needed for the @var.

    class.tx_reports_reports_status_systemstatus.php:195

    typo: oposite -> opposite

    class.tx_reports_reports_status_warningmessagepostprocessor.php:40

    missing parameter name
  2. Christian Kuhn uploaded patch set 2 06/22/12, 17:52

  3. Mr. Jenkins commented on patch set 1 06/22/12, 17:52

  4. Mr. Jenkins commented on patch set 2 06/22/12, 17:52

  5. Christian Kuhn commented on patch set 2 V 0 06/22/12, 17:52

    by team member; Looks good to me, approved
  6. Christian Kuhn merged patch set 2 06/22/12, 17:52