PHP Docblocks - Explaining an array [duplicate]

StackOverflow https://stackoverflow.com/questions/14612773

  •  06-03-2022
  •  | 
  •  

Question

Possible Duplicate:
Is there a way for phpDoc to document an array of objects as a parameter?

I've been searching, and looked at the phpDocumentor documentation but cannot find if there is a way to properly document @param array (as in, declare the keys / values types expected) that will be parsed and included in any generated documentation.

This would lead me to believe there is no way to do it and I'll be resigned to using the description.

Thanks in advance.

Was it helpful?

Solution

@param YourType[] is recognized by at least Eclipse/Zend Studio. I don't know about other IDE's but would expect the same, even if that might not be official phpDocumentor syntax.

However I don't know of any way to document the types of the keys (which are limited to int and string anyway).

Licensed under: CC-BY-SA with attribution
Not affiliated with StackOverflow
scroll top