2

I'm searching for a documentation generation software like phpDocumentor or phpDox for scripts written in PHP.

As both mentioned softwares are running with root permissions (apparently), I can't use them because I'm on a shared server, so the installation on a shared server is the most important point in my search.

I'm allowed to run some shell scripts but not all commands. So I can e.g. use nothing that requires root permissions, which also includes "installing packages". This makes a web-based solution preferable.

Many thanks in advance!

  • As I'm informed, that should be possible with the built-in reflection API without the need of some additional tools: "PHP 5 comes with a complete reflection API that adds the ability to reverse-engineer classes, interfaces, functions, methods and extensions. Additionally, the reflection API offers ways to retrieve doc comments for functions, classes and methods." (source) – Izzy Mar 17 '15 at 9:59
  • Good idea, but with this (I already used this to get some child classes) I'd need to script the documentation by myself. With all styles and so on. But I will give it a try, although I'd appreciate more recommendations for softwares. – alve89 Mar 17 '15 at 11:42
  • Some references for that: How to create documentation using Reflection / What is Reflection in PHP? – and phpDocumentor/Reflection could be the "documentation generation software" you're looking for (not tried myself, hence a comment and not an answer). – Izzy Mar 17 '15 at 12:19
  • Looks quite interesting, may be this works. Thank you! – alve89 Mar 17 '15 at 17:16
  • My thoughts (as I may be in need of something like that as well to get up-to-date – still using the very same tool I've used for about 15 years now, and that hasn't been updated for a while ;) – Izzy Mar 17 '15 at 17:30
2

I would highly recommend http://phpfui.com for this. Runs as a PHP script right on your server. Will produce static files if you need them for high volume sites. Easy to install and set up. Maybe 2 minutes to usable documentation for your code and all the third party code you use in your app.

| improve this answer | |

Your Answer

By clicking “Post Your Answer”, you agree to our terms of service, privacy policy and cookie policy

Not the answer you're looking for? Browse other questions tagged or ask your own question.