Did anyone find phpdocs.moodle.org useful? (It was output from PhpDocumentor).
I was just updating it to 1.9 but getting some out-of-memory errors from PhpDocumentor and other junk so I've given up (and it's gone).
If someone wants to run this site as a reference for the community please let me know and I'll point http://phpdocs.moodle.org to your site.
(Similar to how Campus Management maintain http://xref.moodle.org)
So do I. I SHOULD NOT have to go down to the code at first approach, un less the commented API does not exactly what it ought to do. It is also true that I'm essentially a "third party" developper, so I should have no need really to dig so deep in the core implementation (I do anyway, fellows ). The phpdocs is a first stage documentation that is often far enough to remind a function complete API, and to memoize the variants and derivated.
I think where xRef has real value is as said Matt, when you want to know FROM WHERE the function is called. That is very valuable when you plan to change something in its behaviour.
Cheers.
We may have a server powerfull enough in our school (EISTI) to do this (Moodle is turning into a long run project at EISTI). But I must check administrative authorisations (I'll check my dean) as I come back from Winter vacations. I'm a great consumer of phpdocs !!
I would even have proposed you to complete some and what the comments (essentially phpdoc comments) where I find some uncommented APIs.
I knew about this out-of-memory error. When the code is so big, we need splitting the generation in sub volume and batch them over time. It costed me a one full night compilation on the 1.7 release !! (Pentium4 2.8 Ghz 512Mo)
Martin,
Its OK (may double my last message) for offically supporting phpdocs.moodle.org at EISTI (France). I'm trying a package cleanup to generate a first volume over a last checkout I just made of 1.9 STABLE branch.
Would it make sense we could think again about repacking all code for doc. I think so. I make a local try repacking all modules in mod_modname packages and so will I try with blocks and so on. There would be great benefit if we could repack libraries by main functionnal assignation. I can apply for that, as background activity.
Cheers.
Ok, It will take a little time (raised as top priority task from now) I prepare a good documentation compilation and trigger the job on the remote server. I prepare a blank page on our server.
IP will be 212.73.216.140 that will be backup by 212.73.216.139.
I start by using the backup for compiling and test a first volume, after having repacked modules and other plugins so it can generate nicely.
I prepare virtualhosting and trigger you back.
Cheers.
Martin,
vhosts are setup.
I put a waiter message in them.
check it at : http://moodleprod.recherche.cergy.eisti.fr/moodle_19_phpdocs
This is the "master" server at 212.73.216.140
The backup server will be 212.73.216.139 (where I run the experimental www.ethnoinformatique.fr). You may use it as fallback server.
backup host access is actually :
http://moodletest.recherche.cergy.eisti.fr/moodle_19_phpdocs
I'm trying to get rid of memory limitations with my admins for compiling.
Cheers.