phpSimpleDoc
phpsimpledoc

Troubleshoot


Here is a list of known problem you can encounter while executing phpSimpledoc :
  • Huge execution time : if the project you try to document contains binary files, phpSimpleDoc will try to document them.
    Solution : include the binary files in the list of "DontDoc" user directive.
    Note : if the project you document is large, doc generation can take several minutes.
    Indicative times : it takes about 4 seconds to document phpSimpleDoc (16 000 lines); and about 15 minutes to document Zend Framework (490 000 lines). Most of the time is taken to write the generated files on disk ; these times were measured on a machine with a slow disk (5400 RPM).
  • Write access : the execution of phpSimpleDoc needs a temporary directory with write access.
    In particular, to parse the user directives, the program tries to write a temporary file in directory src/libext/utils.
    Solution : if phpSimpleDoc complains, you should give write access to this directory.
    cd /path/to/phpsimpledoc
    chmod 777 src
    chmod 777 src/libext
    chmod 777 src/libext/utils
    This is quite ugly, but will be fixed in version 1.0 alpha4.