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

Improved support for @alias when documenting inner classes as global.

Browse Source
This commit is contained in:
Michael Mathews 2012-06-06 15:32:16 +01:00
parent 1efee9d908
commit 810dd7f7fd
3 changed files with 34 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
rhino_modules/jsdoc/name.js
View File

@ -24,7 +24,7 @@ exports.resolve = function(doclet) {
about = {},
parentDoc;
doclet.name = name = name? (''+name).replace(/\.prototype\.?/g, '#') : '';
doclet.name = name = name? (''+name).replace(/(^|\.)prototype\.?/g, '#') : '';
// member of a var in an outer scope?
if (name && !memberof && doclet.meta.code && doclet.meta.code.funcscope) {
@ -48,7 +48,7 @@ exports.resolve = function(doclet) {
else { // no @memberof
about = exports.shorten(name);
}
if (about.name) {
doclet.name = about.name;
}
@ -75,8 +75,12 @@ exports.resolve = function(doclet) {
}
else {
if (doclet.name && doclet.memberof && !doclet.longname) {
doclet.scope = 'static'; // default scope when none is provided
if ( /^([#.~])/.test(doclet.name) ) {
doclet.scope = puncToScope[RegExp.$1];
doclet.name = doclet.name.substr(1);
}
else doclet.scope = 'static'; // default scope when none is provided
doclet.setLongname(doclet.memberof + scopeToPunc[doclet.scope] + doclet.name);
}
}

18
test/fixtures/aliasglobal2.js vendored Normal file
View File

@ -0,0 +1,18 @@
(function () {
/**
* Creates a new test object.
* @alias Test
* @constructor
*/
var Test = function(testName) {
/** Document me. */
this.name = testName;
}
/** Document me. */
Test.prototype.run = function(message) {
};
/** Document me. */
Test.counter = 1;
})();

8
test/specs/documentation/alias.js
View File

@ -40,6 +40,14 @@ describe("aliases", function() {
expect(log.scope).toEqual('global');
});
it('When a symbol is documented as an instance member of <global> class it\'s scope is "instance" and not "static".', function() {
var docSet = jasmine.getDocSetFromFile('test/fixtures/aliasglobal2.js'),
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() {