Page MenuHomePhabricator

Audit all methods and add @private and @protected where appropriate
Open, MediumPublic

Description

This has no functional effect on the code, but improves the documentation a lot.

  • No tag should be used for public methods
  • @protected should be used for methods only intended for this and subclasses to access
  • @private should be used for all others

Event Timeline

TrevorParscal assigned this task to matmarex.
TrevorParscal raised the priority of this task from to Medium.
TrevorParscal updated the task description. (Show Details)
TrevorParscal added a project: OOUI.
TrevorParscal subscribed.

Most of the classes I checked (and I checked a lot, not exhaustive though), already have the @protected and @private tags. Should we mark as resolved?

Aklapper added a subscriber: KMenger.

@KMenger: I am resetting the assignee of this task because there has not been progress lately (please correct me if I am wrong!).
Resetting the assignee avoids the impression that somebody is already working on this task. It also allows others to potentially work towards fixing this task.
Please claim this task again when you plan to work on it (via Add Action...Assign / Claim in the dropdown menu)! Thanks for your understanding.