View Full Version : Automatically generating PHP documentation - without using the command line?

08-17-2012, 06:52 PM

I've just spent hours trying to generate PHP documentation for our systems, probably around 800 pages in total and very well commented so figured it'd be a good idea to have it generated automatically. Unfortunately anything I've tried (namely APIgen and phpDocumentor) have required either weird access permissions or internet connections which aren't available on the server - basically every single thing I've tried results in some kind of error.

Is there any alternative I've overlooked, preferably something that can just scan a directory and generate documentation accordingly? I've already spent hours on it I know, but if I can get something that'll work it'll save me weeks, potentially even longer in not having to re-write and collate all of my code and comments.

Thank you :)

08-17-2012, 10:09 PM
I have to ask, why must you not use the command line? Is it because you are using shared hosting? If that is the case I would recommend you install XAMPP, copy your code library to your c: drive and run phpDocumentor there.

08-17-2012, 10:58 PM
Thank you, unfortunately it's the server at work and seems to be quite locked down, any of the files that phpDocumentator tried to write wouldn't work, and any time it tried to connect to the internet the firewall blocked it.

I can see if I can install xampp (again, the computers at work are quite fussy) and copy the code across, that's actually a neat idea, thank you - I think ideally I was hoping for something I could install on my machine (without the need for services, registry changes etc) which could then scan the folders on the server for the files :(

08-20-2012, 12:02 PM
Trying to run phpDocumentor on my local machine now and getting exactly the same errors as I was getting on the server - the firewall blocks both the PEAR and manual installations, I've tried downloading directly from GitHub and installing, I get as far as it trying to generate the documentation but it fails because important files (such as phpDocumentor.ini) are not part of the GitHub install.

Really not sure what to try next - I've asked and I can't take my code away from work, but I cannot generate any documentation from any of the methods online... why has no one made a GUI documenter that doesn't require messing with services, paths etc etc? :(

08-20-2012, 12:17 PM
This is my path, and I'm still receiving 'php.exe is not recognised' errors...!