The bem-jsd from bem

bem-jsd's People

Contributors

Stargazers

Watchers

Forkers

skad0

bem-jsd's Issues

Add more functionality to jsd

At this time jsd hasn't enough functionality to parse jsdoc on bem-history@v2 and bem-mvc@v2.
There we can't generate jsDoc from code like:

/**
 * @exports
 * @class model
 * @augments events:Emitter
 * @bem
 */
var FIELD = MODEL.FIELD = inherit(events.Emitter, /** @lends FIELD.prototype */{ 
...
    /**
     * Some desc
     * @param {Object} params
     * @param {MODEL} model
     */
    someMethod: function(params, model) {
        ...
    }
});

(you can see this code here)

/**
 * @exports
 * @class uri
 * Creates a new Uri object.
 * @param {String} str
 */
function Uri(str) {
    this.uriParts = this.parseUri(str);
    this.queryParams = this.parseQuery(this.normalize(this.uriParts.query));
}

/**
 * Parse string and return Uri instance.
 * @param {String} str
 * @returns {Uri} Uri instance
 */
Uri.parse = function(str) {
    return new Uri(str);
};

/**
 * Normalizes a full url to percentage encoding.
 * @param {String} str input url
 * @returns {String}
 */
Uri.normalize = function(str) {
    return Uri.parse(str).toString();
};

(you can see this code here)

Can you please support such cases in jsd?

Comments without js-doc should be ignored, and not throw an error

Now because of the type plugin:

Error: Error: "Can not add property to non-object node" while processing jsdoc comments started at line 352
----------------------------------------------------------------------------------------------------
            /**
             * Кнопка не будет получать фокус, если у нее есть модификатор `_focus_no`.
             */
            yes: function() {

                return this.hasMod('focus', 'no') ? false : this.__base.apply(this, arguments);