phpDocumentor / phpDocumentor/phpDocumentor

Inline @link in parameter lists

Open
#1,434 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
PHP
Stars
4.3k
Forks
648
Avg merge
28m
Merged PRs (30d)
13

Description

In reference to #710 it would be nice to use inline links in parameter lists, throws, and others.

@param int $foo {@link bar}

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Begin by reviewing related issue #710 and the existing handling of parameter lists, throws, and other tag values. Confirm how the shown inline {@link bar} syntax should behave in each context, then verify that links are recognized and rendered consistently.

Written by the indexing model from the issue text.

Assessment

Tech stack
php
Domain
documentation
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.