Skip to main content

Public

Project privacy set to public. By default, its content is available to everyone (authenticated or not). Please note that more restrictive permissions might exist on some items.

    •  
      request #13354 Make sure PHP annotations are correctly formatted and comments not completly useless
    Actions
    Infos
    #13354
    Thomas Gerbet (tgerbet)
    2019-05-29 16:32
    2019-05-02 10:53
    14475
    Details
    Make sure PHP annotations are correctly formatted and comments not completly useless
    Playing a bit with static analysis tools those days, I encountered a few spots where an annotation was present to mark the variable type but was incorrectly formatted and as a result the tool does not pick up the hint.

    Also we have a non negligible quantity of comments that are not useful like comments telling you what's the name of a class (it's already in the code...) or when the file has been created (we have Git for that).


    We can clean up all of that and enforce it with coding standards rules.
    Dev tools
    Empty
    Empty
    • [ ] enhancement
    • [x] internal improvement
    Empty
    Stage
    Empty
    Closed
    2019-05-29
    Attachments
    Artifact links

    Releases

    Fixed in

    Artifact ID Project Tracker Summary Status Last Update Date Submitted By Assigned to
    rel #13072 Tuleap Releases 11.2 Delivered 2019-05-29 16:32 Manuel Vacelet (vaceletm)
    Empty
    References
    Referencing request #13354

    Git commit

    tuleap/tuleap/stable

    Merge commit 'refs/changes/35/14835/5' of ssh://gerrit.tuleap.net:29418/tuleap into HEAD 89dd23dce0
    User avatar Nicolas Terray (nterray) , 2019-05-02 17:59
    request #13354: Make sure PHP comments are correctly formatted and not completly useless c42963a40b
    User avatar Thomas Gerbet (tgerbet) , 2019-05-02 16:08
    Fix 3 remaining incorrect annotations in the AssetIncluder class 9469f138d4
    User avatar Thomas Gerbet (tgerbet) , 2019-05-03 15:42
    Cleanup comments 4857b86e69
    User avatar Thomas Gerbet (tgerbet) , 2019-05-03 08:55
    Cleanup comments e8f4a4d5b8
    User avatar Thomas Gerbet (tgerbet) , 2019-05-03 08:58
    Display settings

    Follow-ups

    User avatar
    Thomas Gerbet (tgerbet)2019-05-03 13:36
    Reopening, I miss 3 errors while re-formatting the whole codebase:
    FILE: src/common/Dashboard/AssetsIncluder.php
    ----------------------------------------------------------------------------------------------------------------------------
    FOUND 3 ERRORS AFFECTING 3 LINES
    ----------------------------------------------------------------------------------------------------------------------------
    74 | ERROR | Invalid inline documentation comment format "@var \Tuleap\Layout\BaseLayout", expected "@var type $variable".
    77 | ERROR | Invalid inline documentation comment format "@var \Tuleap\Layout\BaseLayout", expected "@var type $variable".
    85 | ERROR | Invalid inline documentation comment format "@var \Tuleap\Layout\BaseLayout", expected "@var type $variable".
    ----------------------------------------------------------------------------------------------------------------------------
    • Status changed from Closed to Reopen
    • Close date cleared