How to document a type of int / float?
| From: | Stefan Neufeind | Date: | Fri, 12 Mar 2004 14:03:22 +0000 |
| Subject: | How to document a type of int / float? | ||
| Groups: | php.pear.doc | ||
| Request: | Send a blank email to pear-doc+get-2965@lists.php.net to get a copy of this message | ||
Hi,
in reference to the recent discussion raised by didou about a
&type.int/float; in the image-graph-docs I wonder how this should be
documented in phpdoc. We could surely define all these occurences as
type mixed, however I don't think this is a benefit to the
documentation. But mentioning only int or float also makes no sense,
since the function can accept both without problems - despite other
functions that maybe demand an int.
A similar question appeared to me at places where either an int or a
string may be supplied. What's the best way to document this? Using
mixed everywhere and just giving "mixed here means int or string" in
the comment doesn't sound like a good solution for me.
Regards,
Stefan