Page MenuHomePhabricator

Document JavaScript code in javascripts/common
Closed, ResolvedPublic


Author: jgonera

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:

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

Version: unspecified
Severity: enhancement



Event Timeline

bzimport raised the priority of this task from to Low.Nov 22 2014, 1:25 AM
bzimport set Reference to bz44127.
bzimport added a subscriber: Unknown Object (MLST).

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

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