Dizmo documentation

With the command python manage.py jsdoc you can generate the documentation of your dizmo. Just as with JSDoc, you add documentation comments directly to your source code like the following:

/**
 * Shows the back of the dizmo
 * @static
 */
showBack: function() {
    dizmo.showBack();
},

The generated documentation is located in the build directory.

Note: The purpose of python manage.py jsdoc is to document the API of your dizmo and not to generate a help page for the users of your dizmo. See User documentation for more information on the help page for your users.

External resources

• JSDoc