Page MenuHomePhabricator

Clarify the PHPDoc of the various get*Title methods of OutputPage
Open, Needs TriagePublic

Description

There were several people somewhat confused about the various title methods of this class recently, when additional HTML was added to the <h1> title because of T306440

The methods in question are:

  • getTitle()
  • getPageTitle()
  • setPageTitle()
  • getDisplayTitle()
  • setDisplayTitle()
  • getHTMLTitle()
  • setHTMLTitle()

This can be improved by the following steps:

  1. Currently the set*Title functions explain what they do and how they can be used, but the get*Title functions do not !
  2. There are no cross references between the functions in the method documentation

Event Timeline

TheDJ renamed this task from Clarify the documentation of the various get*Title methods of OutputPage to Clarify the PHPDoc of the various get*Title methods of OutputPage.Feb 17 2023, 10:47 AM
TheDJ added a project: MediaWiki-General.