133 lines
6.0 KiB
JavaScript
133 lines
6.0 KiB
JavaScript
/*global describe: true, expect: true, it: true, jasmine: true */
|
|
describe("@augments tag", function() {
|
|
var docSet = jasmine.getDocSetFromFile('test/fixtures/augmentstag.js');
|
|
var docSet2 = jasmine.getDocSetFromFile('test/fixtures/augmentstag2.js');
|
|
var docSet3 = jasmine.getDocSetFromFile('test/fixtures/augmentstag3.js');
|
|
var docSet4 = jasmine.getDocSetFromFile('test/fixtures/augmentstag4.js');
|
|
|
|
it('When a symbol has an @augments tag, the doclet has a augments property that includes that value.', function() {
|
|
var bar = docSet.getByLongname('Bar')[0];
|
|
|
|
expect(typeof bar.augments).toBe('object');
|
|
expect(bar.augments[0]).toBe('Foo');
|
|
});
|
|
|
|
it('When an object is extended, the original is not modified', function() {
|
|
var fooProp3 = docSet.getByLongname('Foo#prop3')[0];
|
|
|
|
expect(fooProp3).toBeUndefined();
|
|
});
|
|
|
|
it('When an object is extended, it inherits properties set in parent constructor', function() {
|
|
var fooProp1 = docSet.getByLongname('Foo#prop1')[0];
|
|
var barProp1 = docSet.getByLongname('Bar#prop1')[0];
|
|
|
|
expect(fooProp1.memberof).toBe("Foo");
|
|
expect(barProp1.memberof).toBe("Bar");
|
|
expect(barProp1.description).toBe(fooProp1.description);
|
|
});
|
|
|
|
it('When an object is extended, it inherits properties set on parent prototype', function() {
|
|
var fooProp2 = docSet.getByLongname('Foo#prop2')[0];
|
|
var barProp2 = docSet.getByLongname('Bar#prop2')[0];
|
|
|
|
expect(fooProp2.memberof).toBe("Foo");
|
|
expect(barProp2.memberof).toBe("Bar");
|
|
expect(barProp2.description).toBe(fooProp2.description);
|
|
});
|
|
|
|
it('When an object is extended, it inherits methods set on parent prototype', function() {
|
|
var fooMethod1 = docSet.getByLongname('Foo#method1')[0];
|
|
var barMethod1 = docSet.getByLongname('Bar#method1')[0];
|
|
|
|
expect(fooMethod1.memberof).toBe("Foo");
|
|
expect(barMethod1.memberof).toBe("Bar");
|
|
expect(barMethod1.description).toBe(fooMethod1.description);
|
|
});
|
|
|
|
it('When an object is extended, it may override methods set on parent prototype', function() {
|
|
var fooMethod2 = docSet.getByLongname('Foo#method2')[0];
|
|
var barMethod2 = docSet.getByLongname('Bar#method2')[0];
|
|
|
|
expect(fooMethod2.memberof).toBe("Foo");
|
|
expect(fooMethod2.description).toBe("Second parent method.");
|
|
expect(barMethod2.memberof).toBe("Bar");
|
|
expect(barMethod2.description).toBe("Second child method.");
|
|
});
|
|
|
|
it('When an object is extended, and it overrides an ancestor method, the child does not include docs for the ancestor method.', function() {
|
|
var barMethod2All = docSet.getByLongname('Bar#method2');
|
|
|
|
expect(barMethod2All.length).toBe(1);
|
|
});
|
|
|
|
it('When an object is extended, it inherits properties set on grandparent prototype', function() {
|
|
var fooProp1 = docSet.getByLongname('Foo#prop1')[0];
|
|
var barProp1 = docSet.getByLongname('Bar#prop1')[0];
|
|
var bazProp1 = docSet.getByLongname('Baz#prop1')[0];
|
|
var bazMethod1 = docSet.getByLongname('Baz#method1')[0];
|
|
var bazMethod2 = docSet.getByLongname('Baz#method2')[0];
|
|
var bazMethod3 = docSet.getByLongname('Baz#method3')[0];
|
|
|
|
expect(fooProp1.memberof).toBe("Foo");
|
|
expect(barProp1.memberof).toBe("Bar");
|
|
expect(bazProp1.memberof).toBe("Baz");
|
|
expect(bazProp1.description).toBe("Override prop1");
|
|
expect(bazMethod1.memberof).toBe("Baz");
|
|
expect(bazMethod2.memberof).toBe("Baz");
|
|
expect(bazMethod3.memberof).toBe("Baz");
|
|
});
|
|
|
|
it('(Grand)children correctly identify the original source of inherited members', function(){
|
|
var fooProp1 = docSet.getByLongname('Foo#prop1')[0];
|
|
var barProp1 = docSet.getByLongname('Bar#prop1')[0];
|
|
var barProp3 = docSet.getByLongname('Bar#prop3')[0];
|
|
var bazProp2 = docSet.getByLongname('Baz#prop2')[0];
|
|
var bazProp3 = docSet.getByLongname('Baz#prop3')[0];
|
|
var bazMethod1 = docSet.getByLongname('Baz#method1')[0];
|
|
|
|
expect(fooProp1.inherits).not.toBeDefined();
|
|
expect(barProp3.inherits).not.toBeDefined();
|
|
expect(barProp1.inherits).toBe("Foo#prop1");
|
|
expect(bazProp2.inherits).toBe("Foo#prop2");
|
|
expect(bazProp3.inherits).toBe("Bar#prop3");
|
|
expect(bazMethod1.inherits).toBe("Foo#method1");
|
|
});
|
|
|
|
it('When an object is extended, and it overrides an ancestor property, the child does not include docs for the ancestor property.', function() {
|
|
var bazProp1All = docSet.getByLongname('Baz#prop1');
|
|
|
|
expect(bazProp1All.length).toBe(1);
|
|
});
|
|
|
|
it('When a symbol has an @augments tag, and the parent is not documented, the doclet still has an augments property', function() {
|
|
var qux = docSet2.getByLongname('Qux')[0];
|
|
|
|
expect(typeof qux.augments).toBe('object');
|
|
expect(qux.augments[0]).toBe('UndocumentedThing');
|
|
});
|
|
|
|
|
|
it('When a symbol @augments multiple parents, it inherits methods from all parents', function() {
|
|
var fooMethod1 = docSet3.getByLongname('Foo#method1')[0];
|
|
var barMethod2 = docSet3.getByLongname('Bar#method2')[0];
|
|
var fooBarMethod1 = docSet3.getByLongname('FooBar#method1')[0];
|
|
var fooBarMethod2 = docSet3.getByLongname('FooBar#method2')[0];
|
|
|
|
expect(fooBarMethod1).toBeDefined();
|
|
expect(fooBarMethod2).toBeDefined();
|
|
expect(fooBarMethod1.description).toBe(fooMethod1.description);
|
|
expect(fooBarMethod2.description).toBe(barMethod2.description);
|
|
});
|
|
|
|
it('When a symbol overrides an inherited method without documenting the method, it uses the parent\'s docs', function() {
|
|
var baseMethod1 = docSet4.getByLongname('Base#test1')[0];
|
|
var derivedMethod1All = docSet4.getByLongname('Derived#test1');
|
|
var derivedMethod1 = derivedMethod1All[1];
|
|
|
|
expect(derivedMethod1All.length).toBe(2);
|
|
expect(derivedMethod1.undocumented).not.toBe(true);
|
|
expect(derivedMethod1.description).toBe(baseMethod1.description);
|
|
});
|
|
});
|