Re: Documentation

Hi All I think that each class/interface needs to have an 'Overview' section to give a high level view of it's purpose, some use cases, and a simple example. This could be the same example that is on the examples page for the class/interface. This should list each method with a link the the methods page, each method should also have a simple usage example. How does that sound? (and how could I do this within the current structure?) Cheers John 2008/11/26 John Le Drew <jp@antz29.com>: > Sounds good to me! > > I will press on with that unless we get any opposition... > > Cheers > > J > > 2008/11/26 Philip Olson <philip@roshambo.org>: >>> I want to create an Examples section within SPL for clear use cases >>> and examples for each of the classes / interfaces within the SPL. The >>> idea is that it seems that a lot of the current explanation is >>> targeted very strongly at software engineers post their CS degree. The >>> great majority of PHP users do not fall into this category and it >>> would be great to see more people make use of the SPL classes / >>> interfaces. >>> >>> What do you think? >> >> Sounds great, please get started! :) There was a spurt of SPL documentation >> activity last week and maybe your work will help promote another one. Also, >> feel free to create an examples.xml for each class. So for example: >> >> phpdoc/en/reference/spl/arrayiterator/tutorial.xml >> >> From: >> >> phpdoc/RFC/skeletons/examples.xml >> >> An xml:id could be something like: >> >> spl.arrayiterator.examples-basic >> >> How does this sound to everyone, especially for PhD? >> >> Regards, >> Philip >> >