WordPress.org

Making WordPress.org

Opened 4 years ago

Closed 4 years ago

#1251 closed enhancement (fixed)

DevHub: Add support for inline @see and @link tags in return descriptions

Reported by: DrewAPicture Owned by: drewapicture
Milestone: Priority: normal
Component: Developer Hub Keywords: has-patch
Cc:

Description

Currently, return descriptions are late-escaped on output with esc_html() which doesn't allow for inline @see and @link tags to display as expected. The links are parsed, but the respective {@link and } parts are still present on output.

I spoke with @coffee2code about applying the make_doclink_clickable() method on return descriptions instead and he agrees that should be fine.

As we move more and more toward adding extended documentation to references via the Explanations module, linking parameter and return descriptions to external resources is becoming more common.

Attachments (1)

1251.diff (621 bytes) - added by DrewAPicture 4 years ago.

Download all attachments as: .zip

Change History (2)

@DrewAPicture
4 years ago

#1 @drewapicture
4 years ago

  • Owner set to drewapicture
  • Resolution set to fixed
  • Status changed from new to closed

In 1915:

DevHub: Add support for inline @see and @link tags to be rendered in return descriptions.

Fixes #1251.

Note: See TracTickets for help on using tickets.