Skip to content

Latest commit

 

History

History
30 lines (19 loc) · 848 Bytes

README-jsdoc.md

File metadata and controls

30 lines (19 loc) · 848 Bytes

Code documentation

This page is part of the EmonCMS Devices README

The code comments are available in the [./docs][docs] directory.

To update the documentation add or alter the comments in www/js/index.js and README.md.

Once jsdoc runs a set to flat html files are created in the [./docs][docs] directory showing all the functions, object, arguents and comments available

Update the docs using npm run:

$ npm run docs

Config

the settings for jsdoc are in ./.jsdocs.json

Images

images must be coppied to the /docs directory manually

Hosted

A hosted version (v0.2.3) hosted github pages version is here: http://code.emrys.cymru/devices/