Developer Documentation Classes/Methods/Properties
Development and Programming
Developer Documentation Classes/Methods/Properties
Hi,
Does anyone know of any “decent” documentation for classes, methods and properties?
E.g. the kind of documentation generated by phpDocumentor?
It’s a real pain having to read through each class every time you want to find out what methods are available. Surely there must be some relevant developer docs somewhere?
Thanks in advance.
The EE docs have classes and functions with examples. I don’t know of any other documentation.
Hi Ryan.
Thanks for your input.
Unfortunately the documentation seems to be far from complete. For example the documentation for the Display class:
http://expressionengine.com/docs/development/usage/display.html
Only lists a few properties/methods. (for example, I’m interested in $DSP->table_qcell() )
Under “Class Functions” it says “Consult the list of functions in the Class Reference section.” can anyone shed any light on where the “Class Reference” section is?
**** EDIT ****
Found them! For anyone else missing it, class functions/methods are listed under “ExpressionEngine Functions by Class” section of the list here: http://expressionengine.com/docs/development/index.html
Heh. But of-course…. the function I require information on is not documented! ($DSP->table_qcell())
Back to trawling through source code. :(
This is something I wonder as well. I do believe that to learn the source code well you need to open the classes and read them. But still there is nothing better than a complete Documentation.
Why doesn’t EE have a phpDoc type of Documentation? It is a lot easier to generate than have someone hand craft HTML pages and it is more complete as well.