QCubed - A PHP5 rapid development framework.
Home  |  Updates

Folks, I'm pleased to let you know that QCubed finally has an automated pipeline for generating API documentation. Without further ado: http://api.qcu.be. It's the documentation of the latest bits in the 1.1 branch; it gets regenerated nightly. Remember that it's not the "hottest" thing out there at this point (the design is not ideal, many classes aren't documented perfectly yet), but we're most certainly on our way to better documentation.

The old API docs site, http://qcu.be/doc/api/hierarchy.html, will be retired shortly.

Looking forward to your feedback!

UPDATE 1/20: added bookmarking capability for individual pages (PHPDoc uses frames, it was impossible beforehand). Thanks to jQuery 1.4, it actually wasn't too painful :-)

Steven Warren's picture
Offline
Joined: 11/06/2008
This looks great!

Great job thus far. This is one of the major missing pieces.

alex94040's picture
Offline
Joined: 11/06/2008
Allegro, what would be the

Allegro, what would be the next piece you'd do in terms of the API framework? Or is this good enough, and we should just keep working on the content (i.e. comments for the framework classes)?

Steven Warren's picture
Offline
Joined: 11/06/2008
Only thing I could think of

Only thing I could think of is a way to add user comments much the same way that php.net does. Otherwise I would work on commenting the current codebase.

Also an updated cheatsheet like the one QCodo has http://www.qcodo.com/wiki/qcodo/api. When I started out I found this an invaluable tool. In fact, I taped it under my monitors as a reference.

alex94040's picture
Offline
Joined: 11/06/2008
On the cheatsheet: folks that

On the cheatsheet: folks that were super-passionate about it in QCodo I think are the best folks to build the same thing for QCubed. I personally haven't used the cheatsheet; I'd be a crappy guy to build the new one :). Can we have someone who's excited about it to put their money where their mouth is? :)

On commenting: yes, I agree, it would be great. One idea I had was to embed one of those "allow commenting on anything on your site" plugins. Or maybe there's a way to bring in the Drupal commenting module onto a page that doesn't belong to Drupal? This way, we could do cross-authentication.

On theme-ing: yes, we do have a problem - yet another thing to create a theme for. That said, we have no choice - we're using separate products for separate needs. I'm hopeful we can reuse most design elements (logo, color scheme, HTML navigation bar, etc) across all three - even if that requires copy-pasting.

scottux's picture
Offline
Joined: 11/07/2008
See Alex, I told you that

See Alex, I told you that quick reference was invaluable ;)

User comment capabilities are a must. This has always been a request of the API Documentation system.

Other than that, my only concern is that it is one more component in our website that doesn't match graphically with any other part of the website. We now have a TRAC theme, a QDrupal theme, the examples site theme, and now a phpDocumentor theme. I don't want potential new users to get confused or frustrated bouncing from site to site.

Offline
Joined: 03/31/2008
Agreed, both of those

Agreed, both of those features would be invaluable. :)

akrohn's picture
Offline
Joined: 11/14/2008
Just a note ... api.qcu.be

Just a note ... api.qcu.be does not work for me, only a blank page, but I know it worked some time ago.

How about making a link on the top menu to api.qcu.be (if it's ready).

Btw I never got really used to the phpdoc output. Everytime I get lost just by searching for properties/methods of a control.

I really love the usability of api.qcodo.com using tree navigation. Every information is just 3 clicks away and you know that I'm lazy ;) But thats only my personal view.

Some time ago I played a little around with a ExtJS powered phpdoc template that I found. It got a nice treenav ui and is more userfriendly than the standard templates.

Code: http://zymengine.com/dev/news/30-phpdoc-extjs-converter-template
Example: http://zymengine.com/docs/0.5/api/

Offline
Joined: 03/31/2008
Love it. Wonder how hard that

Love it. Wonder how hard that would be to recreate in jQuery. The right pane still looks like we could throw in an arbitrary address, so I'm hoping it will be easy, even with the drupal node needed for commenting.

alex94040's picture
Offline
Joined: 11/06/2008
I tried this EXACT phpdoc

I tried this EXACT phpdoc template based on extJS. It didn't work for me (crashes).