Last modified: 2014-02-12 23:45:53 UTC

Wikimedia Bugzilla is closed!

Wikimedia migrated from Bugzilla to Phabricator. Bug reports are handled in Wikimedia Phabricator.
This static website is read-only and for historical purposes. It is not possible to log in and except for displaying bug reports and their history, links might be broken. See T46127, the corresponding Phabricator task for complete and up-to-date bug report information.
Bug 44127 - Document JavaScript code in javascripts/common
Document JavaScript code in javascripts/common
Product: MobileFrontend
Classification: Unclassified
Feature requests (Other open bugs)
All All
: Low enhancement
: ---
Assigned To: Nobody - You can work on this!
Depends on:
Blocks: documentation
  Show dependency treegraph
Reported: 2013-01-18 23:32 UTC by Juliusz Gonera
Modified: 2014-02-12 23:45 UTC (History)
10 users (show)

See Also:
Web browser: ---
Mobile Platform: ---
Assignee Huggle Beta Tester: ---


Description Juliusz Gonera 2013-01-18 23:32:12 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.
Comment 1 Michelle Grover 2013-04-28 17:12:27 UTC
Assigned Mingle Ticket
Comment 2 Juliusz Gonera 2013-12-23 22:29:52 UTC
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.
Comment 3 Gerrit Notification Bot 2014-01-01 01:29:11 UTC
Change 104788 had a related patch set uploaded by Jdlrobson:
WIP: Generate JSDoc from Common folder
Comment 4 Gerrit Notification Bot 2014-01-06 19:17:59 UTC
Change 104788 merged by jenkins-bot:
Generate JSDoc from Common folder

Note You need to log in before you can comment on or make changes to this bug.