search

eclipse / paho.mqtt.javascript

paho.mqtt.javascript
Other
1.15k stars 467 forks source link

Add HTML documentation, samples, and downloadable package #30

Closed jpwsutton closed 8 years ago

jpwsutton commented 8 years ago

migrated from Bugzilla #423940 status RESOLVED severity major in component MQTT-JS for --- Reported in version unspecified on platform All Assigned to: Nicholas O'Leary

On 2013-12-12 12:22:00 -0500, Tim Kellogg wrote:

The JavaScript client needs better documentation.

The current documentation needs to be extracted from the source code into HTML & posted online in an easily accessible location. Doing this as part of a build script is ideal.

Online documentation should have samples for several ways to connect - default, authenticated, raised QoS level, etc; publishing and subscribing.

A minified JS file needs to be built and posted online in an easily accessible location.

On 2013-12-12 12:35:17 -0500, Andy Piper wrote:

Agreed that these issues should be addressed, particularly ahead of release plans for 1.0

On 2014-02-01 11:27:49 -0500, Nicholas O'Leary wrote:

* Bug 420221 has been marked as a duplicate of this bug. *

On 2014-02-01 11:28:13 -0500, Nicholas O'Leary wrote:

* Bug 420222 has been marked as a duplicate of this bug. *

On 2014-02-01 11:30:36 -0500, Nicholas O'Leary wrote:

* Bug 420223 has been marked as a duplicate of this bug. *

On 2014-07-03 08:41:49 -0400, Al Stockdill-Mander wrote:

The generated jsDoc is now linked to from the client page on the Paho website. A link to the production zip including a minified version is also linked to on the client page.