Re: Services_Twitter documentation
| From: | David Jean Louis | Date: | Mon, 14 Sep 2009 12:54:53 +0000 |
| Subject: | Re: Services_Twitter documentation | ||
| References: | 1 2 3 4 | Groups: | php.pear.dev |
| Request: | Send a blank email to pear-dev+get-52816@lists.php.net to get a copy of this message | ||
Hey Christian,
Hi David,In this particular case, phpdocumentor won't help, we use __call to intercept API calls, and since we use $twitter->category->method(), I wonder how this should be documented with the @method stuff in Services_Twitter class... Chuck or someone else, any idea ? -- DavidDocumentation is very important indeed, what about setting up a documentation plan and working on it in the next days ? I'm not sure it's a good idea to document each twitter API methodThat's not the scope of peardoc - we have phpdocumentor autogenerated api docs for that. The manual itself shall contain overviews, examples and how-to guides - just as you outlined.