Follow-up to #2135201: Don't impose line length limit on @see directives: Now that we've got long namespaces and class names all over the place in core, the 80 character line length limit causes all sorts of false positives on Doxygen directives like @param, @return, @var, and @covers. Maybe we should just remove the limit on all doxygen directives. Patch to follow.

CommentFileSizeAuthor
#1 coder-doxygen-line-length-2236407-1.patch819 bytestraviscarden

Comments

traviscarden’s picture

traviscarden commented
Assigned: traviscarden » Unassigned
Status: Active » Needs review
StatusFileSize
new coder-doxygen-line-length-2236407-1.patch819 bytes
traviscarden’s picture

traviscarden commented
Issue summary: View changes
klausi’s picture

klausi
he/him||they/them
Primary language German
Location 🇦🇹 Vienna
commented
Version: 7.x-2.x-dev » 8.x-2.x-dev
Status: Needs review » Needs work

Makes sense. This should be fixed in 8.x-2.x first and can then be backported. And this should come with a long @param example in good.php.

I think we should remove the hacky regex matching in 8.x-2.x and should look for the new T_DOC_COMMENT_TAG token instead.

I'm gonna try that now.

  • Commit 237d910 on 8.x-2.x by klausi: 
    Issue #2236407 : Don't impose line length limit on doc comment tags such...
klausi’s picture

klausi
he/him||they/them
Primary language German
Location 🇦🇹 Vienna
commented
Version: 8.x-2.x-dev » 7.x-2.x-dev
Status: Needs work » Postponed (maintainer needs more info)

Fixed in 8.x-2.x, do we even want to backport this? Long @param stuff might not happen that often on D7?

klausi’s picture

klausi
he/him||they/them
Primary language German
Location 🇦🇹 Vienna
commented
Version: 7.x-2.x-dev » 8.x-2.x-dev
Status: Postponed (maintainer needs more info) » Closed (fixed)

Feel free to reopen if you want to work on this for 7.x-2.x.