Uploaded image for project: 'phpBB3'
  1. phpBB3
  2. PHPBB3-11786

Fix various defects in PHPDoc in-code documentation

    Details

    • Type: Improvement
    • Status: Unverified Fix
    • Priority: Minor
    • Resolution: Fixed
    • Affects Version/s: 3.1.0-dev
    • Fix Version/s: 3.1.0-a1
    • Component/s: None
    • Labels:
      None

      Description

      In various places, there are minor and major defects in the PHPDoc in-code documentation. Ranging from spelling/grammar errors to wholly incorrect descriptions, they can be confusing or misleading. Fixing them will help anyone new to the code or refreshing his/her memory to understand the workings more easily.

      I'm creating this issue to address some errors in documentation on events and the notification system, but I propose to make this a general ticket any pull request fixing PHPDoc blocks can refer to.

        Attachments

          Activity

            People

            • Assignee:
              EXreaction EXreaction [X] (Inactive)
              Reporter:
              rechosen rechosen [X] (Inactive)
            • Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved: