Which is the best way to create a documentation for socket.io with jsdoc? | Hashnode

Thread

Davide Polano

Web developer

Jan 12, 2017

Which is the best way to create a documentation for socket.io with jsdoc?

#javascript #nodejs #jsdoc #socketio-cixubvrzh004ekg53togrrvgb

Responses(1)

David Stephan

I am using Angular and then the Angular doc for JSDoc. As such, I am documenting my parent class and functions similar to the following.

/**

@class MyApp.Teams
@ngdoc class
@memberOf MyApp
@description
Module to handle the interface to the Teams, data and views. */

angular.module('MyApp').factory( ...

/**

@name TeamRecord
@ngdoc factory
@memberOf MyApp.Teams
@returns Record Clears the Structure to ""
@description
Team Data Record structure */

So, with your text above, it might look like:

/**

@class MyApp.socketio
@ngdoc class
@memberOf MyApp
@description
Module to handle the interface to the Teams, data and views. */

/**

@name addSocketEvens
@ngdoc function
@memberOf MyApp.socketio
@param {Object} data Some data
@param {string} data.bla Something about bla
@param {number} data.n Some number
@description
This will do that and ... */ exports.addSocketEvents = function(socket) { socket.on('something_1', function(data) { ... });

/**
- Another function that will do ..
- @param {string} id of something */ socket.on('something_2', function(id) { ... });
... };

/**

@name addRoutes
@ngdoc function
@memberOf MyApp.socketio
@param {string} _id Id of bonus document
@description
Will do this and that and will respond with ... */ exports.addRoutes = function(app) { app.patch('/something/:id/juhu', function(req, res) {...});

/**
- GET /something
- Will fetch and respond back with ... */ app.get('/something', function(req, res) {...}); ... };