Review main Merged

11897[TASK] Clean up phpDoc comments in typo3/classes

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

Commit message

Clean up phpDoc comments for the following classes:

* typo3/classes/class.ajaxlogin.php
* typo3/classes/class.clearcachemenu.php
* typo3/classes/class.livesearch.php
* typo3/classes/class.modulemenu.php
* typo3/classes/class.shortcutmenu.php
* typo3/classes/class.typo3_tcefile.php
* typo3/classes/class.typo3ajax.php
* typo3/classes/class.typo3logo.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
    • Susi Moog +2
  • Verified V +2
    • Susi Moog +2

Issues 1

Files 8

Review log 11

  1. Oliver Klee commented on patch set 1 06/11/12, 17:25

    (8 inline comments)

    class.modulemenu.php:55

    No @return for constructors, please.

    class.modulemenu.php:102

    object -> TYPO3AJAX

    class.modulemenu.php:303

    The parameter name is missing.

    class.shortcutmenu.php:74

    Constructors have no return value and thus must have no @return.

    class.typo3_tcefile.php:158

    string -> array

    class.typo3_tcefile.php:159

    string -> TYPO3AJAX

    class.typo3ajax.php:109

    The parameter names are missing.

    class.typo3ajax.php:163

    The parameter name is missing.
  2. Oliver Klee commented on patch set 1 06/11/12, 17:25

    I would prefer that you didn't submit this
  3. Mr. Jenkins commented on patch set 1 06/11/12, 17:25

  4. Wouter Wolters commented on patch set 1 06/11/12, 17:25

    Will resubmit in 3 hours:)

    class.modulemenu.php:55 Reply

    Done

    class.modulemenu.php:102 Reply

    Done

    class.modulemenu.php:303 Reply

    Done

    class.shortcutmenu.php:74 Reply

    Done

    class.typo3_tcefile.php:158 Reply

    Done

    class.typo3_tcefile.php:159 Reply

    Done

    class.typo3ajax.php:109 Reply

    Done

    class.typo3ajax.php:163 Reply

    Done
  5. Wouter Wolters commented on patch set 1 06/11/12, 17:25

    (8 inline comments)
  6. Susi Moog uploaded patch set 3 06/11/12, 17:25

  7. Mr. Jenkins commented on patch set 2 06/11/12, 17:25

  8. Mr. Jenkins commented on patch set 3 06/11/12, 17:25

  9. Wouter Wolters uploaded patch set 2 06/11/12, 17:25

  10. Susi Moog commented on patch set 3 V 0 06/11/12, 17:25

    by team member; Looks good to me, approved Merged as no-brainer.
  11. Susi Moog merged patch set 3 06/11/12, 17:25