Review main Merged

75662[DOCS] Improve doc comments for events for modifying flex form parsing

Lina Wolf CR +2 V +2 Normal +56 −2 updated 09/15/22, 13:44

Commit message

I added and improved non-trivial method descriptions from the Changelog
descriptions here: https://review.typo3.org/c/Packages/TYPO3.CMS/+/75158
to the source code. This also eases usage for Coders who use the code
as documentation.

Some parts of the class comments were also improved.

Review

  • Code review CR +2 Done
    • Lina Wolf +2
    • Oli Bartsch +1
  • Verified V +2 Done
    • Lina Wolf +2
    • Oli Bartsch +1
    • core-ci +1 CI

Issues 1

Files 4

Review log 2029

Show 24 earlier messages
  1. Lina Wolf uploaded patch set 1 09/08/22, 13:16

  2. Lina Wolf marked it work in progress 09/08/22, 13:16

  3. core-ci voted on patch set 1 V -1 09/08/22, 13:24 Core CI is not happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/30819

  4. core-ci commented on patch set 1 09/09/22, 09:12 Core CI is not happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/30819

  1. Lina Wolf uploaded patch set 2 09/11/22, 10:50

  2. Lina Wolf uploaded patch set 3 09/11/22, 10:52

  3. core-ci voted on patch set 2 V -1 09/11/22, 10:58 Core CI is not happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/30960

  4. core-ci voted on patch set 3 V +1 09/11/22, 11:00 Core CI is happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/30961

  5. Lina Wolf marked it ready for review 09/11/22, 17:23

  6. Oliver Klee commented on patch set 3 09/11/22, 18:30

    BeforeFlexFormDataStructureIdentifierInitializedEvent.php:101

    AFAIK, ReST syntax does not work in PHPDoc. Instead, you can use backticks to mark code: `null`
  7. Oli Bartsch commented on patch set 3 09/12/22, 12:14

    AfterFlexFormDataStructureIdentifierInitializedEvent.php:22

    which is

    AfterFlexFormDataStructureIdentifierInitializedEvent.php:53

    two whitespaces

    AfterFlexFormDataStructureIdentifierInitializedEvent.php:91

    Since this code comment is not rendered by docs, let's remove the syntax highlighting annotations. Also not quite sure if we should just copy the content from changelogs into the PHP classes.
  8. Lina Wolf commented on patch set 3 09/12/22, 15:01

    AfterFlexFormDataStructureIdentifierInitializedEvent.php:91 Reply

    On contrary, the code here is rendered in the documentation. Just like we render the ViewHelper reference from the the Doc comments in the ViewHelper classes we render the comments from all Events into the Events reference. I agree with removing the :php: though marking it as code by backticks is sufficient.
  9. Lina Wolf rebased onto patch set 4 09/13/22, 17:46

  10. core-ci voted on patch set 4 V +1 09/13/22, 17:53 Core CI is happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/31063

  11. Lina Wolf uploaded patch set 5 09/13/22, 17:56

  12. Lina Wolf commented on patch set 5 09/13/22, 17:57

    AfterFlexFormDataStructureIdentifierInitializedEvent.php:22 Reply

    Done

    AfterFlexFormDataStructureIdentifierInitializedEvent.php:53 Reply

    Done

    AfterFlexFormDataStructureIdentifierInitializedEvent.php:91 Reply

    Done

    BeforeFlexFormDataStructureIdentifierInitializedEvent.php:101 Reply

    Done
  13. core-ci voted on patch set 5 V +1 09/13/22, 18:03 Core CI is happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/31064

  14. Oli Bartsch commented on patch set 5 09/15/22, 12:57

    AfterFlexFormDataStructureIdentifierInitializedEvent.php:91 Reply

    This sounds really interesting, I wasn't aware of this. Where can I find the rendered version?
  15. Oli Bartsch commented on patch set 5 09/15/22, 13:04

    AfterFlexFormDataStructureIdentifierInitializedEvent.php:53 Reply

    still two whitespaces

    AfterFlexFormDataStructureIdentifierInitializedEvent.php:80

    I suggest to replace this with "Allows to"

    AfterFlexFormDataStructureParsedEvent.php:46

    Could we please remove them here and in the other comments as well?

    AfterFlexFormDataStructureParsedEvent.php:55

    I suggest to replace this with "Allows to"

    BeforeFlexFormDataStructureParsedEvent.php:54

    two whitespaces
  16. Lina Wolf uploaded patch set 6 09/15/22, 13:22

  17. Lina Wolf uploaded patch set 7 09/15/22, 13:23

  18. Lina Wolf uploaded patch set 8 09/15/22, 13:28

  19. Lina Wolf commented on patch set 8 09/15/22, 13:29

    AfterFlexFormDataStructureIdentifierInitializedEvent.php:53 Reply

    Now it should really be gone

    AfterFlexFormDataStructureIdentifierInitializedEvent.php:80 Reply

    Done

    AfterFlexFormDataStructureIdentifierInitializedEvent.php:91 Reply

    AfterFlexFormDataStructureParsedEvent.php:46 Reply

    Done

    AfterFlexFormDataStructureParsedEvent.php:55 Reply

    Done

    BeforeFlexFormDataStructureParsedEvent.php:54 Reply

    Done
  20. core-ci voted on patch set 7 V +1 09/15/22, 13:32 Core CI is happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/31118

  21. core-ci voted on patch set 6 V +1 09/15/22, 13:34 Core CI is happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/31117

  22. core-ci voted on patch set 8 V +1 09/15/22, 13:36 Core CI is happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/31119

  23. Oli Bartsch voted on patch set 8 V +1 CR +1 09/15/22, 13:43

  24. Lina Wolf commented on patch set 8 V +2 CR +2 09/15/22, 13:44

    Contains only documentation changes
  25. Lina Wolf merged patch set 9 09/15/22, 13:44