Uploaded image for project: 'Plugins'
  1. Plugins
  2. CONTRIB-8095

Enforce coding guidelines for inline tags in phpdocs

XMLWordPrintable

    • Icon: Bug Bug
    • Resolution: Fixed
    • Icon: Minor Minor
    • None
    • 3.7.6, 3.8.3, 3.9
    • Local: PHPdoc checker
    • None
    • MOODLE_37_STABLE, MOODLE_38_STABLE, MOODLE_39_STABLE

      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:

      1. @link will be used always to link to URLs (and not to elements).
      2. @see will be used always to link to FDQN element (and not to URLs).
      3. 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.

            stronk7 Eloy Lafuente (stronk7)
            stronk7 Eloy Lafuente (stronk7)
            Votes:
            1 Vote for this issue
            Watchers:
            1 Start watching this issue

              Created:
              Updated:
              Resolved:

                Error rendering 'clockify-timesheets-time-tracking-reports:timer-sidebar'. Please contact your Jira administrators.