Is phpdocs.moodle.org working?

Is phpdocs.moodle.org working?

de către Tim Hunt-
Număr de răspunsuri: 5
Fotografia lui Core developers Fotografia lui Documentation writers Fotografia lui Particularly helpful Moodlers Fotografia lui Peer reviewers Fotografia lui Plugin developers
Things like the class list seem to be incomplete, and a lot of the pages seem to be blank. Is there something wrong with the system, or is it just that the question bank code needs to be better documented before PHPdoc will recognise it?
Media aprecierilor: -
Ca răspuns la Tim Hunt

Re: Is phpdocs.moodle.org working?

de către Martin Dougiamas-
Fotografia lui Core developers Fotografia lui Documentation writers Fotografia lui Moodle HQ Fotografia lui Particularly helpful Moodlers Fotografia lui Plugin developers Fotografia lui Testers
Seems there was a bug, fixed now. MDLSITE-153

Still doesn't make it any more useful though surâs
Media aprecierilor: -
Ca răspuns la Martin Dougiamas

Re: Is phpdocs.moodle.org working?

de către Tim Hunt-
Fotografia lui Core developers Fotografia lui Documentation writers Fotografia lui Particularly helpful Moodlers Fotografia lui Peer reviewers Fotografia lui Plugin developers
Great, thanks. Yes, now we just need to start writing more useful doc comments.
Media aprecierilor: -
Ca răspuns la Martin Dougiamas

Re: Is phpdocs.moodle.org working?

de către Tim Hunt-
Fotografia lui Core developers Fotografia lui Documentation writers Fotografia lui Particularly helpful Moodlers Fotografia lui Peer reviewers Fotografia lui Plugin developers
Martin's comment from that issue:

Ah, i think the .php in some filenames was making it be interpreted by apache as php ... fixed now by disabling php for that domain (and I updated it to phpdocumentor 1.3.1 and Moodle 1.8).

These will help with improving documentation:



I wanted to reply here because it thought it could do with more general discussion.

Surely, developers are mostly interested in HEAD, so why are we building phpdocs from a stable branch?

In an ideal world, I would like to see would be http://phpdocs.moodle.org/ having the docs for head, and http://phpdocs.moodle.org/1.8, http://phpdocs.moodle.org/1.7, etc having the docs for the various supported stable branches. And all this automatically rebuilt once a day by cron.

Of course, this is not very high priority.

And the other side of the equation is improving the quality of the comments in the code, so the PHPdocs are a useful reference.
Media aprecierilor: -
Ca răspuns la Tim Hunt

Re: Is phpdocs.moodle.org working?

de către Howard Miller-
Fotografia lui Core developers Fotografia lui Documentation writers Fotografia lui Particularly helpful Moodlers Fotografia lui Peer reviewers Fotografia lui Plugin developers
If I stumble across an undocumented function and I know the answer I add the PHPdocs (well, mostly). If everybody could be persuaded to do likewise.....
Media aprecierilor: -
Ca răspuns la Tim Hunt

Re: Is phpdocs.moodle.org working?

de către Martin Dougiamas-
Fotografia lui Core developers Fotografia lui Documentation writers Fotografia lui Moodle HQ Fotografia lui Particularly helpful Moodlers Fotografia lui Plugin developers Fotografia lui Testers
Actually my impression is that most module developers and casual developer would be developing against the stable branches (think extensions to fit into a University).

I hope most of the core developers have enough of Moodle in their head (or a good IDE face cu ochiul ) that they don't need this web-based reference. limba scoasă

+100 for more phpdocs on every function, though.
Media aprecierilor: -