Re: Documentation

On Wed, Nov 26, 2008 at 18:08, Philip Olson <philip@roshambo.org> wrote: >> 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, Definitely. I'll see if I can't finish the engine interfaces in the next days. > feel free to create an examples.xml for each class. So for example: > > phpdoc/en/reference/spl/arrayiterator/tutorial.xml Since <extname>/<classname>/*.xml is "dedicated" to method docs, and we will probably get example "chapters" for some of the classes I think creating a "examples" (phpdoc/en/reference/spl/examples/) folder with class-/interfacename.xml files would be the most logical location.. Then we can create phpdoc/en/reference/spl/examples.xml <part> container containing the entity references (similar to what we do in phpdoc/en/language/predefined/interfaces.xml). -Hannes