[WIP] Awesome API Documentation

.gitignore

@@ -31,3 +31,4 @@ node_modules
 coverage
 
 dist
+docs

.npmignore

@@ -33,4 +33,5 @@ node_modules
 .npm
 
 # Optional REPL history
-.node_repl_history
+.node_repl_history
+docs

package.json

@@ -9,9 +9,10 @@
     "test": "aegir-test",
     "test:node": "aegir-test --env node",
     "test:browser": "aegir-test --env browser",
-    "release": "aegir-release",
-    "release-minor": "aegir-release --type minor",
-    "release-major": "aegir-release --type major",
+    "docs": "aegir-docs",
+    "release": "aegir-release --docs",
+    "release-minor": "aegir-release --type minor --docs",
+    "release-major": "aegir-release --type major --docs",
     "coverage": "aegir-coverage",
     "coverage-publish": "aegir-coverage publish"
   },
@@ -37,16 +38,16 @@
   },
   "homepage": "https://github.com/libp2p/js-libp2p-identify#readme",
   "devDependencies": {
-    "aegir": "^9.1.1",
+    "aegir": "^9.2.0",
     "chai": "^3.5.0",
     "pre-commit": "^1.1.3",
     "pull-pair": "^1.1.0"
   },
   "dependencies": {
-    "multiaddr": "^2.0.3",
+    "multiaddr": "^2.1.1",
     "peer-id": "^0.8.0",
-    "peer-info": "^0.8.0",
-    "protocol-buffers": "^3.1.8",
+    "peer-info": "^0.8.1",
+    "protocol-buffers": "^3.2.1",
     "pull-length-prefixed": "^1.2.0",
     "pull-stream": "^3.5.0"
   },
@@ -56,4 +57,4 @@
     "Richard Littauer <[email protected]>",
     "greenkeeperio-bot <[email protected]>"
   ]
-}
+}

src/dialer.js

@@ -1,12 +1,20 @@
 'use strict'
+
 const PeerInfo = require('peer-info')
 const PeerId = require('peer-id')
 const multiaddr = require('multiaddr')
 const pull = require('pull-stream')
 const lp = require('pull-length-prefixed')
 
 const msg = require('./message')
-
+/**
+ * @alias dialer
+ * @memberof libp2p-identify
+ * @param {Connection} conn
+ * @param {function(Error?, PeerInfo, Array<Multiaddr>)} callback
+ * @returns {undefined}
+ *
+ */
 module.exports = (conn, callback) => {
   pull(
     conn,

src/index.js

@@ -1,6 +1,19 @@
+/**
+ * Identify is a STUN protocol, used by libp2p-swarmin order to
+ * broadcast and learn about the `ip:port` pairs a specific
+ * peer is available through and to know when a new stream
+ * muxer is established, so a conn can be reused.
+ *
+ * @module libp2p-identify
+ */
 'use strict'
 
 exports = module.exports
+
+/**
+ * @type {string}
+ */
 exports.multicodec = '/ipfs/id/1.0.0'
+
 exports.listener = require('./listener')
 exports.dialer = require('./dialer')

src/listener.js

@@ -5,10 +5,20 @@ const lp = require('pull-length-prefixed')
 
 const msg = require('./message')
 
+/**
+ * @alias listener
+ * @memberof libp2p-identify
+ * @param {Connection} conn
+ * @param {PeerInfo} pInfoSelf
+ * @returns {undefined}
+ *
+ */
 module.exports = (conn, pInfoSelf) => {
   // send what I see from the other + my Info
   conn.getObservedAddrs((err, observedAddrs) => {
-    if (err) { return }
+    if (err) {
+      return
+    }
     observedAddrs = observedAddrs[0]
 
     let publicKey = new Buffer(0)