peej/phpdoctor

Feature request - regenerate docs only for modified files

nathanl opened this issue · 1 comments

We are now running PHPDoctor as a nightly cron job on our code base. Since it's large, this takes several hours.

One neat feature would be the ability to say "only regenerate documentation for files that git shows as changed."

I realize this would be complicated - you'd have to store a record of parent-child class relationships on disk, I imagine - but I thought I'd mention the idea.

peej commented

That's a pretty massive codebase if it takes several hours, it's cool to hear that you're using it on such a big project and it's working for you.

The best way to implement this from my initial thoughts would be to somehow cache the processed doc objects and then overwrite any created by files that have been modified. And finally to regenerate all the documentation via the doclet.

It might also help with your memory problem if the solution requires creating an intermediate doc object format to be written to disk.