Closed Bug 762591 Opened 13 years ago Closed 10 years ago

Auto-generate documentation of public Mozmill APIs

Categories

(Testing Graveyard :: Mozmill, defect)

Product:
Testing Graveyard
Component:
Mozmill
Type:
defect
Priority:
Not set
Severity:
normal

Tracking

(Not tracked)

Status:
RESOLVED WONTFIX

People

(Reporter: whimboo, Unassigned)

Details

We have to create an user (developer) friendly documentation of using Mozmill for creating tests and hacking the framework. For Python we should use Sphinx and could probably publish the docs to readthedocs. See moztrap docs: http://readthedocs.org/docs/moztrap/en/latest/ For JS we use the jsdoc comment style now across the files. By using jsdoc toolkit we could automatically create a rich documentation. See what we have for our mozmill-tests api refactor project: http://people.mozilla.com/~hskupin/docs/mozmill-tests/outline/ Keep in mind that we need a customized template for our purposes for jsdoc toolkit.
Summary: Use jsdoc toolkit to generate documentation of public Mozmill APIs → Auto-generate documentation of public Mozmill APIs
Mozmill will reach its end of life soon. We are currently working on getting all the tests for Firefox ported to Marionette. For status updates please see bug 1080766.
Status: NEW → RESOLVED
Closed: 10 years ago
Resolution: --- → WONTFIX
Product: Testing → Testing Graveyard
You need to log in before you can comment on or make changes to this bug.