Ondřej has posted 1 posts at DZone. View Full User Profile

APIGen Plugin: PHP Project API Generator

  • submit to reddit

Do you need to generate API documentation for your PHP project? There is nothing easier than to use APIGen and its APIGen NetBeans plugin.

APIGen plugin is tool which integrates API documentation generator APIGen into the NetBeans IDE. You can simply generate project API documentation from the PHP project context menu. The most known API documentation generated by APIGen is the Nette Framework API documentation.

If you want to know more information you can read them in the blog post about PHP APIGen support in the NetBeans IDE.

Published at DZone with permission of its author, Ondřej Brejla.

(Note: Opinions expressed in this article and its replies are the opinions of their respective authors and not those of DZone, Inc.)


Arian Maykon replied on Tue, 2011/01/18 - 7:33am

Nice, but why don't use the PHPDoc/JavaDoc standarts? Or i'm wrong?

Ondřej Brejla replied on Tue, 2011/01/18 - 11:34am

PHPDoc? You mean that "old veteran" which can't handle PHP 5.3 features like namespaces and which is not developed anymore? You can use the same "annotation syntax" for APIGen and it's really really faster then phpDocumentor. It takes 11s to generate the Nette Framework documentation using APIGen and more than 2mins using phpDocumentor.

But you can use whatever you want. This is just another possibility.

More information about APIGen [cz] - http://phpfashion.com/jak-se-pise-generator-api-dokumentace

Jeff Rubinoff replied on Thu, 2011/01/20 - 12:49pm

The APIGen doesn't seem to read NetBeans global include path. It failed on a small ZF project because it could not find Zend_Application_Bootstrap_Bootstrap. The project runs just fine.

Also, you might want to look into changing the plugin so it does not have a build-specific dependency on the NB PHP component. Otherwise you will have to create a new version of the plugin for every NB release. I'm fairly certain that there's a way to write the plugin so the dependency is not build-specific, but I don't know how to do this myself :( Anyway, it won't install on 7.0 builds.

Ondřej Brejla replied on Thu, 2011/01/20 - 1:07pm in response to: Jeff Rubinoff

Yes, it doesn't read NB global include path, it just runs APIGen scripts and they don't know your path... But thats great feature request, I'll try to fix it in the next version.

Answer to the second part is written here: APIGen plugin - plugin portal (and it's specified there, that it works with 6.9.1 (Build 201007282301) - because of the PHP dependency)

Goran Miskovic replied on Fri, 2011/02/04 - 5:56am

Nice idea and I guess nice work. I would truly like to give it a try, but since I am running NB nightly builds, due to PHP dependency, I can't. :( You should fix that ASAP. :)

Ondřej Brejla replied on Fri, 2011/02/04 - 6:15am in response to: Goran Miskovic

Hope that there will be some kind of public API in PHP module in the NetBeans 7.0 stable :-)

Ryan Fitz replied on Mon, 2011/11/21 - 2:07am in response to: Ondřej Brejla

I hope so too if not it can take a lot of time Fitzmagic shirt

Mateo Gomez replied on Wed, 2012/06/06 - 1:13am

API gen is always a good thing...it broadens your options

mexican dessert

Matt Coleman replied on Thu, 2012/06/07 - 3:37am in response to: Ondřej Brejla

that is my hope too graphic artist buffalo

Jason Bourne replied on Wed, 2012/12/12 - 7:10am in response to: Matt Coleman

Very nice site and article. Amazing one, i appreciate this work.... This is a wonderful post Hey I see smart blog, I love it greatly because I cannot find anything better than your authors.Thanks, I agree that this will be a great help for me Lighted Wall Art 

Cata Nic replied on Mon, 2013/09/02 - 4:47pm

 Just another great solution, easy to integrate with a big project. I am thinking at the best way of implementing this script into my website.

Comment viewing options

Select your preferred way to display the comments and click "Save settings" to activate your changes.