PhpDocs: Link to another method in "@param" tag's description?

Question

Is it possible to link to another method/class/property/etc of my project, inline inside the @param tag?

Like this:

/**
 * My method's description.
 *
 * @param string $myArg Pass here result of {@link myOtherMethod()}.
 *
 * @return bool
 */
public function myMethod($myArg) {
    // TODO: code here.
}

...

Top-Master · Accepted Answer · 2023-02-01 20:08:12Z

0

Both PhpDoc (phpDocumentor) and doxygen support inline-link to other method.

For phpDocumentor

Use:

{@link myOtherMethod()}

Or:

{@link MyClass::myOtherMethod()}

But unlike doxygen, seems inline-link is not everywhere supported, see PhpDocs: Link to another method in "@deprecated" tag's description?

For doxygen:

{@link #myOtherMethod}

Or:

{@link MyClass#myOtherMethod}

Or even just:

myOtherMethod()

Note that human-readability of un-compiled docs matters, hence phpDocumentor syntax should be used, because it's more known (by PHP developers at least).

But once doxygen supports that same PhpDoc syntax, it's no issue to generate docs with doxygen, because once docs are compiled, it does not matter with what tool they were compiled, they are readable either way.

edited Feb 1, 2023 at 20:08

answered Feb 1, 2023 at 19:45

Top-Master

9,0396 gold badges52 silver badges97 bronze badges

Sign up to request clarification or add additional context in comments.

Collectives™ on Stack Overflow

PhpDocs: Link to another method in "@param" tag's description?

1 Answer 1

For phpDocumentor

For doxygen:

Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

For phpDocumentor

For doxygen:

Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related