Details
-
Bug
-
Status: Closed
-
Minor
-
Resolution: Fixed
-
3.7.6, 3.8.3, 3.9
-
None
-
None
-
MOODLE_37_STABLE, MOODLE_38_STABLE, MOODLE_39_STABLE
Description
This is about to enforce the policy decided recently () about the use of inline tags.
Policy: phpdoc @link and @see tags usage
Since 13th May 2020, these rules apply:
- @link will be used always to link to URLs (and not to elements).
- @see will be used always to link to FDQN element (and not to URLs).
- Both tags can be used standalone or inline, within a phpdoc comment.
- Basically, allow both tags to be used inline.
- Ideally verify that @link always is followed by url.
- Ideally verify that both @link and @see are followed by 1 word only (url or fdqn).
(note, this has to be done in the local_moodlecheck plugin.
Attachments
Issue Links
- has been marked as being related by
-
MDLSITE-6105 PHPDocs: Clarify/modify @link and @see phpdoc allowed usage
-
- Closed
-