<< One more 0.11 Release Candidate Getting started with Doctrine and symfony 1.1 >>

Php.net style API documentation lookups

Php.net style API documentation lookups

Posted by jwage 7 months ago

I have been using php.net style API lookups ever since I can remember. It is very nice being able to simply go to http://php.net/array_walk and have it pull up that function in the PHP API Documentation. So, tonight i have implemented this functionality in to the Doctrine website. Below are some examples of how you can quickly access the API docs for a specific function or class.


Comments (5) [ add comment ]

not *entirely* working - Posted by Alex about 7 months ago.

I get "Oops! The page you asked for could not be found".. Cool idea though!

Posted by jwage about 7 months ago.

Unfortunately, right after I posted this, the api docs started their scheduled regeneration from svn and it didn't finish for some reason. It never fails ;) Looking in to it.

Working now - Posted by isleshocky77 about 7 months ago.

Nice work wage. Although I do often use this as well in php, I think the best part about it is how often creates the best search results in google. Hopefully this will now be the case as well in Doctrine.

How about Doxygen? - Posted by CCs about 7 months ago.

I really like the doxygen generated documentation - not a great design, but I can easily find anything, even withing hundreds of classes.

See VTK for ex. http://www.vtk.org/doc/release/5.0/html/

It's generated automatically from the source, so it's up to date, full cross reference etc.

What's wrong? - Posted by shun about 7 months ago.

I can see just the API index.

How or where can I get the details?

Create Comment
Enter 'follow the doctrine' without the quotes