Last modified: 2014-02-12 23:45:53 UTC
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.
Assigned Mingle Ticket https://mingle.corp.wikimedia.org/projects/mobile/cards/718
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