Review main Merged

29425[TASK] Improve comments and phpdoc blocks in PageRepository

mostwanted CR +2 V +2 Hard +212 −86 updated 04/12/14, 15:24

Commit message

* fix comment line lengths to improve readability and meet the CGL
* add some additional line breaks in comments to improve readability
* add missing @throws annotations in phpdoc blocks
* add missing @var annotations in phpdoc blocks

Review

  • Code review CR +2
    • Christian Kuhn +2
    • Oliver Klee +1
  • Verified V +2
    • Christian Kuhn +2

Issues 1

Files 1

Review log 20

  1. mostwanted uploaded patch set 2 04/12/14, 11:50

  2. mostwanted uploaded patch set 3 04/12/14, 11:51

  3. mostwanted uploaded patch set 4 04/12/14, 11:51

  4. Markus Klein commented on patch set 4 04/12/14, 11:56

    PageRepository.php:108

    Add @var annotations for all properties here too please.

    PageRepository.php:173

    Is this possible? can the doc parsers read this such that the second+ line belongs to the param?
  5. Mr. Jenkins commented on patch set 1 04/12/14, 12:04

  6. Mr. Jenkins commented on patch set 2 04/12/14, 12:09

  7. Mr. Jenkins commented on patch set 3 04/12/14, 12:18

  8. Mr. Jenkins commented on patch set 4 04/12/14, 12:23

  9. mostwanted commented on patch set 4 04/12/14, 12:25

    PageRepository.php:108 Reply

    will upload another patch set shortly

    PageRepository.php:173 Reply

    http://phpdoc.org/docs/latest/references/phpdoc/tags/param.html --- quote --- The @param tag MAY have a multi-line description and does not need explicit delimiting. --- /quote ----
  10. mostwanted uploaded patch set 5 04/12/14, 12:40

  11. Mr. Jenkins commented on patch set 5 04/12/14, 13:00

  12. Christian Kuhn commented on patch set 5 CR -1 04/12/14, 13:11

    While this is a nice cleanup, there is imho no point in having all those multi line @param annotations, our code is often longer than 80 chars, too, and that is ok nowadays. Lets not start with this here, there is no benefit to do that for annotations. Would you like to streamline the comments and merge into one line again or should I do that?
  13. mostwanted commented on patch set 5 04/12/14, 14:28

    hi christian, thanks for your feedback. i will remove the multiline docblock comment descripion and push it again. nevertheless i thought it would also be good to have short docblock tag comments to make them more readable. but maybe i am wrong here. and there are of course more important things to do that this.
  14. mostwanted uploaded patch set 6 04/12/14, 14:41

  15. mostwanted uploaded patch set 7 04/12/14, 14:41

  16. Oliver Klee voted on patch set 7 CR +1 04/12/14, 14:52

  17. Mr. Jenkins commented on patch set 6 CR -1 V -1 04/12/14, 14:55

  18. Mr. Jenkins commented on patch set 7 04/12/14, 15:00

  19. Christian Kuhn commented on patch set 7 V +2 CR +2 04/12/14, 15:24

    Thank you! This is a clear improvement now and should be ok without further reviews and discussions. Since the patch is "only" touches comments and no code, this is merged now.
  20. Christian Kuhn merged patch set 8 04/12/14, 15:24