jsdoc/test/specs/documentation/moduleisconstructor.js
Dominic Chambers 28cb42de33 Added missing coverage around modules that contain a default CommonJs
class being exported within the module -- this has actually shown that
the doclets produced are probably correct, and that the bug is likely to
be within the template.
2014-08-19 16:53:58 +01:00

37 lines
1.3 KiB
JavaScript

/*global describe: true, expect: true, it: true, xdescribe: true */
describe('module that exports a constructor', function() {
var docSet = jasmine.getDocSetFromFile('test/fixtures/moduleisconstructor.js');
var modules = docSet.doclets.filter(function(doclet) {
return doclet.kind === 'module';
});
var classes = docSet.doclets.filter(function(doclet) {
return doclet.kind === 'class';
});
it('should include one doclet whose kind is "module"', function() {
expect(modules.length).toBe(1);
expect(modules[0].kind).toBe('module');
});
it('should include one doclet whose kind is "class"', function() {
expect(classes.length).toBe(1);
expect(classes[0].kind).toBe('class');
});
describe('class doclet', function() {
it('should include a "description" property that contains the constructor description', function() {
expect(classes[0].description).toEqual('Create a new configuration.');
});
it('should include a "class-description" property', function() {
expect(classes[0].classdesc).toEqual('Describe the class here.');
});
});
describe('module doclet', function() {
it('should include a "description" property that contains the module description', function() {
expect(modules[0].description).toEqual('Describe the module here.');
});
});
});