Blog

New symfony API documentation

Jobeet, learn symfony step by step, 24 days, 1 hour a day

« Back to the Blog

Categories

Feeds

feed Posts feed

comments feed Comments feed

Be trained by symfony experts
Jan 21: Paris (1.2 - Francais)
Feb 04: Montpellier (1.2 - Français)
Feb 18: Paris (1.2 - Francais)
Mar 11: Nantes (1.2 - Français)
Mar 18: Paris (1.2 - Français)
and more...

Archives

Creative Commons License This work is licensed under a Creative Commons Attribution-Noncommercial-No Derivative Works 3.0 Unported License.

As we want full symfony code coverage for the API documentation before the release of symfony 1.0, Ian and François has worked a lot on adding phpdoc tags for the helper functions. They work hard but sadly enough, their work was not available online due to the way we generate the pages for the API documentation.

I'm very happy that this is fixed now. I rewrote the parser from scratch and you can now browse the brand new API documentation online.

Enjoy!

P.S.: If you want to help us fixing and adding more phpdoc tags to the symfony code, you can send me an e-mail.

Comments comments feed

gravatar
#1 Robert said about 3 hours later

Great news! However, I miss something really useful in the symfony API doc: the inherited methods. Would it be possible to make them appear?

gravatar
#2 fabien said about 3 hours later

Just click on the [more] link on the right

gravatar
#3 marckohlbrugge said about 7 hours later

Looks great!

gravatar
#4 ed said about 16 hours later

Looks great!
Though the return type seems to now be missing for those methods that return an object instance eg: getRequest();
That was quite useful :)

gravatar
#5 snk00sj said about 18 hours later

Thats really good ! Very good job guys.

gravatar
#6 Roger said 1 day later

Maybe it should be nice to display classes in a tree form, eg:

* sfAction
* sfActions
* etc.

gravatar
#7 nexor said 1 day later

I agree with Ed - any chances for adding return types linked to appropriate classes?
Besides that - good work guys.

gravatar
#8 Ahmed Shaikh Memon said 26 days later

Hey Fabien, I will be more than happy to work with you guys. Let me know if you need my 1 to 2 hours a day for any php related task for the symfony.

gravatar
#9 John said about 1 month later

It's very interesting site!