NuSphere Forums Forum Index
NuSphere Forums
Reply to topic
Documentation generators - PHPDoc is outdated


Joined: 14 Sep 2010
Posts: 18
Reply with quote
Can a more up to date documentation generator be incorporated into PHPEd?

The current generator, PHPDocumentor, does NOT support PHP 5.3 and has not been actively maintained for over 3 years.

Here are some alternatives:

  • phpdoctor
  • phpdox
  • Docblox
  • Doxygen

EDIT:
Links removed because they were obfuscated by the forum.
View user's profileFind all posts by hurrakanSend private message
Site Admin

Joined: 13 Jul 2003
Posts: 7857
Reply with quote
Yep, you're right.
But there is nothing specific in PhpED to let it run PHP Documentor only. You can easily integrate it with something else that would work from a command line and understands certain parameters -- which you'll set in Tools->Settings->Integration.

_________________
The PHP IDE team
View user's profileFind all posts by dmitriSend private messageVisit poster's website


Joined: 06 Jul 2009
Posts: 72
Reply with quote
What might be nice, is to have a selection of the most popular (such as hurrakan's list as an example) and allow it to be set in the project properties dialog.

I started looking at doxygen (which IMO, looks to be the better replacement for phpDocumentor from the list above) but some of the keywords and the syntax is different. If we could specify a preferred documentation engine for a project.. when creating dox-style comments, it could adjust to use the selected syntax style, currently this appears to be fixed to phpDocumentor-style @keyword, whereas doxygen appears to use \keyword (I've only had a quick glance, so hoping I'm right here) Smile Also code-completion for the selected engine would be really nice too like we already have for phpDocumentor.



Cheers..

Ian
View user's profileFind all posts by Ian.HSend private message


Joined: 14 Sep 2010
Posts: 18
Reply with quote
Just saw an interesting article about DocBlox published on phpdeveloper.org.

This forum is not very useful if we can't post links.

Luckily it's very easy to work around:

http://www.phpdeveloper.org/news/16672

(you'll have to copy/paste though)
View user's profileFind all posts by hurrakanSend private message
Guru master

Joined: 24 Jul 2009
Posts: 712
Reply with quote
I think you can show links after you've a certain number of posts, maybe to make sure you are not a spammer:

http://www.phpdeveloper.org/news/16672

Fortunately PHPDoc is still used by most of the projects that I work with, but I would certainly be interested in a more modern standard being supported by PhpED.

Whilst it is possible to use anything we like with external utilities, having PhpED use the documentation method (for code hints, etc.) is surely very useful?
View user's profileFind all posts by plugnplaySend private message


Joined: 14 Sep 2010
Posts: 18
Reply with quote
A deeper look at DocBlox:

http://www.dragonbe.com/2011/08/quality-assurance-on-php-projects.html
View user's profileFind all posts by hurrakanSend private message
Documentation generators - PHPDoc is outdated
You cannot post new topics in this forum
You cannot reply to topics in this forum
You cannot edit your posts in this forum
You cannot delete your posts in this forum
You cannot vote in polls in this forum
All times are GMT - 5 Hours  
Page 1 of 1  

  
  
 Reply to topic