Hello and welcome to our community! Is this your first visit?
Register
Enjoy an ad free experience by logging in. Not a member yet? Register.
Results 1 to 5 of 5
  1. #1
    New to the CF scene
    Join Date
    Oct 2008
    Posts
    6
    Thanks
    0
    Thanked 0 Times in 0 Posts

    Automatically generating PHP documentation - without using the command line?

    Hi,

    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

  • #2
    UE Antagonizer Fumigator's Avatar
    Join Date
    Dec 2005
    Location
    Utah, USA, Northwestern hemisphere, Earth, Solar System, Milky Way Galaxy, Alpha Quadrant
    Posts
    7,691
    Thanks
    42
    Thanked 637 Times in 625 Posts
    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.

  • #3
    New to the CF scene
    Join Date
    Oct 2008
    Posts
    6
    Thanks
    0
    Thanked 0 Times in 0 Posts
    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

  • #4
    New to the CF scene
    Join Date
    Oct 2008
    Posts
    6
    Thanks
    0
    Thanked 0 Times in 0 Posts
    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?

  • #5
    New to the CF scene
    Join Date
    Oct 2008
    Posts
    6
    Thanks
    0
    Thanked 0 Times in 0 Posts
    This is my path, and I'm still receiving 'php.exe is not recognised' errors...!

    C:\xampp\php;C:\xampp\php\phpDocumentor\bin;C:\xampp\php\apigen;


  •  

    Posting Permissions

    • You may not post new threads
    • You may not post replies
    • You may not post attachments
    • You may not edit your posts
    •