Jsdoc правильный способ документировать socket.on('event', function() {}) и обработчик маршрутов

Как документировать API с помощью jsdoc, который имеет следующую форму (один файл)

// api.js

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

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

   ...
};

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

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

Моя единственная идея - добавить @namespace выше экспорта и @lends выше анонимных функций, но это приводит к пустой документации.

/** * @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 */

/** * @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) {...}); ... };

Ответ 1