Document JavaScript code in javascripts/common
Closed, ResolvedPublic
Actions

Assigned To

None

Authored By

	• bzimport
	Jan 18 2013, 11:32 PM

Description

Author: jgonera

Description:
The objects and functions from files in the common directory are our building blocks. They should be well documented so that writing new modules and reviewing code is easier.

Proper way of documenting JS code is described here:
https://www.mediawiki.org/wiki/Manual:Coding_conventions/JavaScript#Documentation

Documenting this code should be done together with refactoring some of its parts.

Version: unspecified
Severity: enhancement

Details

Reference: bz44127

Event Timeline

• bzimport raised the priority of this task from to Low.Nov 22 2014, 1:25 AM

• bzimport added a project: MobileFrontend-Feature-requests.

• bzimport set Reference to bz44127.

• bzimport added a subscriber: Unknown Object (MLST).

• bzimport created this task.Jan 18 2013, 11:32 PM

mgrover wrote:

Assigned Mingle Ticket https://mingle.corp.wikimedia.org/projects/mobile/cards/718

jgonera wrote:

We should check with the VE team to know what's the most up-to-date tool they use to generate docs from comments before we start working on this.

Change 104788 had a related patch set uploaded by Jdlrobson:
WIP: Generate JSDoc from Common folder

https://gerrit.wikimedia.org/r/104788

Change 104788 merged by jenkins-bot:
Generate JSDoc from Common folder

https://gerrit.wikimedia.org/r/104788

Aklapper added a project: Documentation.Jan 7 2015, 3:37 PM

• Awjrichards unsubscribed.Jan 7 2015, 5:33 PM

MarcoAurelio removed a parent task: T2001: [DO NOT USE] Documentation is out of date, incomplete (tracking) [superseded by #Documentation].Dec 6 2017, 7:32 PM

Document JavaScript code in javascripts/commonClosed, ResolvedPublicActions

Description

Details

Event Timeline

Document JavaScript code in javascripts/common
Closed, ResolvedPublic
Actions