mirror of
https://github.com/jsdoc/jsdoc.git
synced 2025-12-08 19:46:11 +00:00
As part of this commit, we automatically flag rest parameters as repeatable, even if the JSDoc comment doesn't identify the parameter as repeatable. As a result, it's difficult to document a rest parameter as though it were a normal parameter (should you want to do that for some reason). I may revert this piece if it generates complaints.
22 lines
772 B
JavaScript
22 lines
772 B
JavaScript
'use strict';
|
|
|
|
describe('rest parameters', function() {
|
|
var docSet = jasmine.getDocSetFromFile('test/fixtures/restparams.js');
|
|
var setAdmins = docSet.getByLongname('setAdmins')[0];
|
|
var setWidgetAccess = docSet.getByLongname('setWidgetAccess')[0];
|
|
|
|
it('should automatically mark standalone rest parameters as repeatable', function() {
|
|
var restParam = setAdmins.params[0];
|
|
|
|
expect(restParam.name).toBe('users');
|
|
expect(restParam.variable).toBe(true);
|
|
});
|
|
|
|
it('should automatically mark rest parameters as repeatable when they are mixed with other params', function() {
|
|
var restParam = setWidgetAccess.params[1];
|
|
|
|
expect(restParam.name).toBe('users');
|
|
expect(restParam.variable).toBe(true);
|
|
});
|
|
});
|