start on documentation

.gitignore

@@ -11,6 +11,7 @@ pids
 logs
 results
 /coverage
+/out
 
 node_modules
 npm-debug.log

jsdoc.conf

@@ -0,0 +1,3 @@
+ {
+    "plugins": ["plugins/markdown"]
+}

lib/marshallers.js

@@ -8,7 +8,7 @@ const {
   MAX_UINT64_STR, MIN_UINT64_STR
 } = require('./constants');
 
-/**
+/*
  * MakeSimpleMarshaller
  * @param signature - the signature of the data you want to check
  * @returns a simple marshaller with the "check" method

lib/service/interface.js

@@ -10,6 +10,13 @@ let {
   assertMemberNameValid
 } = require('../validators');
 
+/**
+ * An error that can be thrown from DBus methods and property getters and
+ * setters to return the error to the client.
+ *
+ * @param {string} type - The type of error. Must be a valid DBus member name.
+ * @param {string} text - The error text. Will be seen by the client.
+ */
 class DBusError extends Error {
   constructor(type, text) {
     assertInterfaceNameValid(type);
@@ -21,6 +28,32 @@ class DBusError extends Error {
   }
 }
 
+/**
+ * A decorator function to define an Interface class member as a property. The
+ * property will be gotten and set from the class when users call the standard
+ * DBus methods `org.freedesktop.DBus.Properties.Get`,
+ * `org.freedesktop.DBus.Properties.Set`, and
+ * `org.freedesktop.DBus.Properties.GetAll`.
+ *
+ * @example
+ * class MyInterface extends Interface {
+ *   // use a @ in place of {at} (jsdoc bug)
+ *   {at}property({signature: 's'})
+ *   get MyProp() {
+ *     return this.myProp;
+ *   }
+ *   set MyProp(value) {
+ *     this.myProp = value;
+ *   }
+ * }
+ *
+ * @param {object} options - The options for this property.
+ * @param {string} options.signature - The DBus type signature for this property.
+ * @param {string} [options.name] - The name of this property on the bus.
+ * Defaults to the name of the class member being decorated.
+ * @param {bool} [options.disabled=false] - Whether or not this property
+ * will be advertized on the bus.
+ */
 function property(options) {
   options.access = options.access || ACCESS_READWRITE;
   if (!options.signature) {

package.json

@@ -51,13 +51,15 @@
     "babel-core": "^7.0.0-bridge.0",
     "babel-jest": "^23.6.0",
     "commander": "^2.19.0",
-    "jest": "^24.1.0"
+    "jest": "^24.1.0",
+    "jsdoc": "git+https://github.com/jsdoc3/jsdoc.git"
   },
   "scripts": {
     "integration": "dbus-run-session -- jest ./test/integration",
     "coverage": "dbus-run-session -- jest --coverage",
     "unit": "jest ./test/*.test.js",
-    "test": "dbus-run-session -- jest"
+    "test": "dbus-run-session -- jest",
+    "doc": "jsdoc --verbose -c jsdoc.conf --readme README.md --package package.json -r lib"
   },
   "engine": {
     "node": ">=8.2.1"