search

moodlehq / moodle-local_moodlecheck

Checks style of phpdocs in moodle source file
26 stars 31 forks source link

readme

Moodle PHPdoc Checker

Moodlecheck CI

Important note:

This plugin is becoming deprecated and, soon, moodle-cs will get the baton about all the PHPDoc checks. The switch is planned to be implemented progressively. For more details, see the announcement and the tracking issue.

Installation:

Install the source into the local/moodlecheck directory in your moodle

Log in as admin and select:

Settings Site administration Development Moodle PHPdoc check

Enter paths to check and select rules to use.

Customization:

You can add new rules by adding new php files in rules/ directory, they will be included automatically.

Look at other files in this directory for examples.

Please note that if you register the rule with code 'mynewrule', the rule registry will look in language file for strings 'rule_mynewrule' and 'error_mynewrule'. If they are not present, the rule code will be used instead of the rule name and default error message appears.