Uploaded image for project: 'Moodle'
  1. Moodle
  2. MDL-65180

Review all the dml and ddl @package and @category phpdocs

    XMLWordPrintable

    Details

    • Type: Task
    • Status: Open
    • Priority: Minor
    • Resolution: Unresolved
    • Affects Version/s: 3.7
    • Fix Version/s: None
    • Component/s: Database SQL/XMLDB
    • Labels:
      None
    • Affected Branches:
      MOODLE_37_STABLE

      Description

      From MDL-65168:

      2) About the @package and @category phpdocs... (reported by cibot) I've been reviewing the history, and really we have had a bad history there.

      Correct alternatives are (for code):

      a) package = core (the component)
      b) category = dml (the API).

      And for tests:

      a) package = core (the component)
      b) category = test (the API).

      Note that there is MDL-31457 about to consider dml and ddl APIs, but that never came to reality. Until then... they are "just" core APIs, hence the above. Also, it seems that we fixed all the bad uses @ MDL-30972, just to move back to the incorrect ones few months later @ MDL-32003.

      So this is about to:

      1) Decide if MDL-31457 should be done or no.
      2) With 1) decided, apply for the correct @package and @category over all the dml/ddl stuff.

      Ciao

        Attachments

          Issue Links

            Activity

              People

              • Assignee:
                Unassigned
                Reporter:
                stronk7 Eloy Lafuente (stronk7)
                Participants:
                Component watchers:
                Jake Dallimore, Jun Pataleta
              • Votes:
                0 Vote for this issue
                Watchers:
                0 Start watching this issue

                Dates

                • Created:
                  Updated: