mirror of
https://github.com/jsdoc/jsdoc.git
synced 2025-12-08 19:46:11 +00:00
44d9ec6831
consumes ASTs that follow the Mozilla Parser API spec: https://developer.mozilla.org/en-US/docs/SpiderMonkey/Parser_API passes all tests on OS X; performance is comparable to previous version. also includes some miscellaneous cleanup. remaining issues: - only Rhino AST builder is supported - node visitors (old and new) may not be hooked up yet - circular-reference issues in doclets - docs are (mostly) missing - various other TODO comments
69 lines
3.2 KiB
JavaScript
69 lines
3.2 KiB
JavaScript
/*global describe: true, expect: true, it: true, jasmine: true */
|
|
describe("aliases", function() {
|
|
describe("standard", function() {
|
|
var docSet = jasmine.getDocSetFromFile('test/fixtures/alias.js');
|
|
var found = docSet.getByLongname('myObject').filter(function($) {
|
|
return ! $.undocumented;
|
|
});
|
|
var foundMember = docSet.getByLongname('myObject.myProperty');
|
|
|
|
it('When a symbol is given an alias it is documented as if the name is the alias value.', function() {
|
|
expect(found[0].longname).toEqual('myObject');
|
|
});
|
|
|
|
it('When a symbol is a member of an alias it is documented as if the memberof is the alias value.', function() {
|
|
expect(foundMember[0].longname).toEqual('myObject.myProperty');
|
|
expect(foundMember[0].memberof).toEqual('myObject');
|
|
});
|
|
});
|
|
|
|
it('When a symbol is a member of an alias of a nested name it is documented as if the memberof is the nested alias value.', function() {
|
|
var docSet = jasmine.getDocSetFromFile('test/fixtures/alias2.js');
|
|
var foundMember = docSet.getByLongname('ns.Myclass#myProperty');
|
|
|
|
expect(foundMember[0].longname).toEqual('ns.Myclass#myProperty');
|
|
expect(foundMember[0].name).toEqual('myProperty');
|
|
expect(foundMember[0].memberof).toEqual('ns.Myclass');
|
|
expect(foundMember[0].scope).toEqual('instance');
|
|
});
|
|
|
|
it('When a symbol is a member of an aliased class, a this-variables is documented as if it were a member that class.', function() {
|
|
var docSet = jasmine.getDocSetFromFile('test/fixtures/alias3.js');
|
|
var tcm = docSet.getByLongname('trackr.CookieManager')[0];
|
|
var tcmValue = docSet.getByLongname('trackr.CookieManager#value')[0];
|
|
|
|
expect(tcmValue.memberof).toEqual('trackr.CookieManager');
|
|
});
|
|
|
|
it('When a symbol is documented as a static member of <global>, its scope is "global" and not "static".', function() {
|
|
var docSet = jasmine.getDocSetFromFile('test/fixtures/aliasglobal.js');
|
|
var log = docSet.getByLongname('log')[0];
|
|
|
|
expect(log.scope).toEqual('global');
|
|
});
|
|
|
|
it('When a symbol is documented as an instance member of <global>, its scope is "instance" and not "static".', function() {
|
|
var docSet = jasmine.getDocSetFromFile('test/fixtures/aliasglobal2.js');
|
|
var run = docSet.getByLongname('Test#run')[0];
|
|
|
|
expect(run.scope).toEqual('instance');
|
|
expect(run.memberof).toEqual('Test');
|
|
});
|
|
|
|
describe("resolving", function() {
|
|
it('When a local reference has alias, put all members into aliased definition. Local modifications should be visible to outside.', function() {
|
|
var docSet = jasmine.getDocSetFromFile('test/fixtures/aliasresolve.js');
|
|
var method = docSet.getByLongname('A.F.method');
|
|
|
|
expect(method.length).toEqual(1);
|
|
});
|
|
|
|
it('When a reference in an outer scope has alias, put all members into aliased definition. Local modifications are visible to outside.', function() {
|
|
var docSet = jasmine.getDocSetFromFile('test/fixtures/aliasresolve2.js');
|
|
var method = docSet.getByLongname('A.F.method');
|
|
|
|
expect(method.length).toEqual(1);
|
|
});
|
|
});
|
|
});
|