I wish this one occurred to me sooner.
For a long time I struggled with internals of WordPress (and my… intuitive PHP skills contributed to issue). I decided that I need some kind of indexing. WikidPad didn’t fit task well. I wanted something like online WordPress code references such as one by Joost de Valk.
Then it shined on me I can make my own with same tools. PHPXref is utility that takes any PHP code and creates easy to use cross-referenced documentation.
What it does
App scans directory with code and digests all files in it to produce set of documentation in HTML format. It generates:
- lists of functions, classes, variables and constants;
- all of those are highlighted in code and linked to their definitions;
- comments (if present) are automatically used for function descriptions;
- native PHP functions are linked to their official documentation.
It is still same code but presented in form much easier to navigate and understand. With all explanations always only click away.
Minimum required is only setting directory to scan in there.
For those who wish to tinker there are many more settings, including option to change documentation appearance.
I don’t like how embedded search works, it doesn’t seem to work with partial function names. On other hand it is easy enough to look things up in generated lists.
Documentations also ends up quite large. My docs for WordPress with all of plugins used and few themes almost reached 170 megabytes.
Pure bliss for browsing and understanding PHP code (WordPress or whatever else). I learned more in only few days since I generated docs than in months before that.
Freeware, open source and easily scriptable to keep docs fresh.