PHPDoc inline {@link} (and Netbeans)

Question

Perhaps I'm not understanding completely, but I'm trying to get the {@link} inline PHPDoc tag to link to another method in the class (the docblock in question is for a "shorthand alias" method)

I haven't actually generated anything to documentation, but the {@link} is showing as plain-text in the NetBeans method descriptor. Am I doing something wrong syntactically (if I compile the documentation will this work?) or just that NetBeans is unable to support the inline {@link}?

For example:

class MyClass
{

    /**
     * Shorthand alias for {@link MyClass::method()}
     *
     * @param mixed $foo
     * @param mixed $bar
     * @return mixed
     */
    public function __invoke($foo, $bar)
    {
        return $this->method($foo, $bar);
    }

    /**
     * Does stuff with $foo and $bar
     *
     * @param mixed $foo
     * @param mixed $bar
     * @return mixed
     */
    public function method($foo, $bar)
    {
        // ...
    }

}

Netbeans doesn't support all of PHP doc (yet!), it'll probably work. — John Carter
– John Carter, Commented Oct 7, 2011 at 20:58

hakre · Accepted Answer · 2011-10-07 20:50:26Z

4

Compile the documentation, it should work then, otherwise PHPDoc will spit out an error message telling you more.

Netbeans might not support all PHPDoc features, you can also try @see.

answered Oct 7, 2011 at 20:50

hakre

200k55 gold badges454 silver badges866 bronze badges

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

2 Comments

Nux Over a year ago

Also see an issue for autocomplete here: netbeans.org/bugzilla/show_bug.cgi?id=200891

hakre Over a year ago

@Nux: Thanks for the cross-link, very valuable!

Collectives™ on Stack Overflow

PHPDoc inline {@link} (and Netbeans)

1 Answer 1

2 Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

2 Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related