archive-gh-me/jsdoc
1
0
Fork 0
mirror of https://github.com/jsdoc/jsdoc.git synced 2025-12-08 19:46:11 +00:00
Code Issues Projects Releases Wiki Activity

clean up tests

Browse Source
This commit is contained in:
Jeff Williams 2014-03-18 22:02:58 -07:00
parent 8128dc5335
commit 463065d996
1 changed files with 15 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
test/specs/tags/defaulttag.js
View File

@ -1,63 +1,66 @@
/*global describe: true, expect: true, it: true, jasmine: true */
describe("@default tag", function() {
var docSet = jasmine.getDocSetFromFile('test/fixtures/defaulttag.js');
var request = (docSet.getByLongname('request') || [])[0];
var response = (docSet.getByLongname('response') || [])[0];
var rcode = (docSet.getByLongname('rcode') || [])[0];
var rvalid = (docSet.getByLongname('rvalid') || [])[0];
var rerrored = (docSet.getByLongname('rerrored') || [])[0];
var win = (docSet.getByLongname('win') || [])[0];
var header = (docSet.getByLongname('header') || [])[0];
var obj = docSet.getByLongname('obj')[0];
var multilineObject = docSet.getByLongname('multilineObject')[0];
var arr = docSet.getByLongname('arr')[0];
it('When symbol set to null has a @default tag with no text, the doclet\'s defaultValue property should be: null', function() {
var request = docSet.getByLongname('request')[0];
expect(request.defaultvalue).toBe('null');
});
it('When symbol set to a string has a @default tag with no text, the doclet\'s defaultValue property should be that string', function() {
var response = docSet.getByLongname('response')[0];
expect(response.defaultvalue).toBe('ok');
});
it('When symbol set to a number has a @default tag with no text, the doclet\'s defaultValue property should be that number.', function() {
var rcode = docSet.getByLongname('rcode')[0];
expect(rcode.defaultvalue).toBe('200');
});
it('When symbol has a @default tag with text, the doclet\'s defaultValue property should be that text.', function() {
var win = docSet.getByLongname('win')[0];
expect(win.defaultvalue).toBe('the parent window');
});
it('When symbol has a @default tag with true.', function() {
var rvalid = docSet.getByLongname('rvalid')[0];
expect(rvalid.defaultvalue).toBe('true');
});
it('When symbol has a @default tag with false.', function() {
var rerrored = docSet.getByLongname('rerrored')[0];
expect(rerrored.defaultvalue, 'false');
});
it('When symbol has a @default tag with a function call.', function() {
var header = docSet.getByLongname('header')[0];
expect(header.defaultvalue).toBeUndefined();
});
it('When symbol has a @default tag with an object, the doclet should contain the stringified object', function() {
var obj = docSet.getByLongname('obj')[0];
var testObj = { valueA: 'a', valueB: false, valueC: 7};
expect(obj.defaultvalue).toBe( JSON.stringify(testObj) );
expect(obj.defaultvaluetype).toBe('object');
});
it('When symbol has a @default tag with a multiline object, the doclet should contain the stringified object', function() {
var multilineObject = docSet.getByLongname('multilineObject')[0];
var testObj = {
valueA: 'a',
valueB: false,
valueC: 7
};
expect(obj.defaultvalue).toBe( JSON.stringify(testObj) );
expect(obj.defaultvaluetype).toBe('object');
expect(multilineObject.defaultvalue).toBe( JSON.stringify(testObj) );
expect(multilineObject.defaultvaluetype).toBe('object');
});
it('When symbol has a @default tag with an array, the doclet should contain the stringified array', function() {
var arr = docSet.getByLongname('arr')[0];
var testArray = ['foo', true, 19];
expect(arr.defaultvalue).toBe( JSON.stringify(testArray) );
expect(arr.defaultvaluetype).toBe('array');
});