Yeah, and I forgot to mention that the API docs do let you drill into the source, so you can wade through the code if the docs aren't self- explanatory.
The problem with the API docs, is that they are typical code generated documentation, so it's helpful once you have an understanding of the framework, but not terribly useful if you're trying to learn something. Great reference, not a great tutorial I guess is my point. The quality of the documentation on the API calls is entirely dependent on how well the developer wrote their comments for the API in question, which from my experience is great sometimes, but often requires walking through the code to understand (since most of us developers spend more time on getting the code working than updating documentation and comments). Back to the original question, the API docs do an excellent job of telling you what the parameters are, and what the parameters default to, so that is the best place to look for what Nancy is looking for. On Dec 15, 8:43 pm, mark_story <mark.st...@gmail.com> wrote: > If you click on a class you should get a list of its methods and their > parameters. For > example,http://api.cakephp.org/class_controller.html#903188d3de83bd65c78bb676... > should take you to Controller::redirect(). > And the API is generated off of the source code, so it would be very > similar to reading the source ;) > > -Mark > > On Dec 15, 7:37 pm, Rob <webwe...@gmail.com> wrote: > > > Your best bet is to look at the cook book, it has much easier to > > follow documentation. > > > The API docs are great once you understand the basic concepts, but for > > the most part they aren't much better than reading the source code > > most of the time. > > >http://book.cakephp.org/view/219/the-cakephp-blog-tutorial > > > On Dec 11, 8:57 am, Nancy <nancy.milli...@gmail.com> wrote: > > > > So, I've been trying to use the API documentation found > > > here:http://api.cakephp.org/classes.html > > > > But I can't figure out how to find the parameters and options that one > > > can send to the methods. Is there better documentation of the API > > > elsewhere or am I just not using it correctly? > > > > Thanks! > > > > Nancy > > --~--~---------~--~----~------------~-------~--~----~ You received this message because you are subscribed to the Google Groups "CakePHP" group. To post to this group, send email to cake-php@googlegroups.com To unsubscribe from this group, send email to cake-php+unsubscr...@googlegroups.com For more options, visit this group at http://groups.google.com/group/cake-php?hl=en -~----------~----~----~----~------~----~------~--~---
