current community

your communities

more stack exchange communities

company blog
Stack Exchange Inbox Reputation and Badges
tour help
Stack Overflow is a community of 4.7 million programmers, just like you, helping each other.

Join them; it only takes a minute:

Sign up
Join the Stack Overflow community to:
  1. Ask programming questions
  2. Answer and help your peers
  3. Get recognized for your expertise
up vote 2 down vote favorite
1

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.

share|improve this question
up vote 5 down vote accepted

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)

share|improve this answer
    
Perfect, thanks. Ironic that developers that create software used for documenting code don't document their code very well.. :) – Naatan Nov 14 '11 at 21:34
2  
Actually, they do: manual.phpdoc.org/HTMLframesConverter/default and click on @param – halfdan Nov 14 '11 at 21:35
    
I suppose I must have read it too fast, thanks :) – Naatan Nov 14 '11 at 21:47

Your Answer

 
discard

By posting your answer, you agree to the privacy policy and terms of service.

Not the answer you're looking for? Browse other questions tagged or ask your own question.