Page MenuHomePhabricator

Provide minimal doxygen documentation for SkinFallback
Open, Needs TriagePublic

Description

https://doc.wikimedia.org/ is a Doxygen installation.

MediaWiki core includes a "Fallback" skin. It's what you see if somehow wgDefaultSkin isn't available. It isn't visible to users. (Try it by adding ?useskin=fallback to a page, see for example: https://www.mediawiki.org/wiki/MediaWiki?useskin=fallback

Because SkinFallback is in MediaWiki core (see the code search results), it shows up in Doxygen's class diagrams that are otherwise helpful for class Skin, but the generated documentation for SkinFallback is terrible.

It only needs a few changes:

  • merge the two comment blocks at the top of these files
  • add the explanation I gave above
  • improve the confusing overlapping statements
    • "Skin template for the fallback skin
    • "SkinTemplate class for the fallback skin

I don't think the files should be marked \@ingroup Skins since it's not relevant to other skins.

Event Timeline

Spage raised the priority of this task from to Needs Triage.
Spage updated the task description. (Show Details)
Spage added a subscriber: Spage.
Restricted Application added a project: Documentation. · View Herald TranscriptOct 21 2015, 2:51 AM
Restricted Application added a subscriber: Aklapper. · View Herald Transcript
Swathi-0901 removed Swathi-0901 as the assignee of this task.Nov 5 2018, 12:33 PM
Swathi-0901 added a subscriber: Swathi-0901.

@Florian Hi I would like to work on this task. Can you tell me where do I need to add the above description in this file https://doc.wikimedia.org/mediawiki-core/master/php/classSkinFallback.html. Also the second link mentioned in the description is not working. Please guide!

Aklapper updated the task description. (Show Details)Fri, Oct 30, 10:33 PM

In the meantime, SkinFallbackTemplate was removed in 26d5f78f84d57fca007700f143b2c51ab8840d69 so I'm going to remove that from the task description.

Aklapper updated the task description. (Show Details)Fri, Oct 30, 10:36 PM
Aklapper removed a subscriber: Spage.