phpDoc, class instance as @param?

Question

When using phpdoc on a function I have an argument that always contains an instance of a class, is there any way to document this in phpdoc so that the generated phpdoc links to the given class?

Something like @param MyClass() $var.

I can't find any info on it in the documentation, in fact the documentation doesn't even mention objects (stdClass) type params, period.

halfdan · Accepted Answer · 2011-11-14 21:32:29Z

5

You need to remove the parenthesis and it should work out of the box:

@param MyClass $var Parameter takes instance of MyClass

The formal syntax for this is:

@param type [$varname] description

Have a look at the documentation http://manual.phpdoc.org/HTMLframesConverter/default/ (you need to click on @param on the left)

answered Nov 14, 2011 at 21:32

halfdan

34.3k8 gold badges82 silver badges88 bronze badges

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

2 Comments

Naatan Over a year ago

Perfect, thanks. Ironic that developers that create software used for documenting code don't document their code very well.. :)

halfdan Over a year ago

Actually, they do: manual.phpdoc.org/HTMLframesConverter/default and click on @param

Collectives™ on Stack Overflow

phpDoc, class instance as @param?

1 Answer 1

2 Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

2 Comments

Your Answer

Sign up or log in

Post as a guest

Related