Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Apply https://github.com/jsdoc/jsdoc/pull/1686 #2046

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 1 addition & 1 deletion packages/jsdoc-parse/lib/handlers.js
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@ function createSymbolDoclet(comment, e, deps) {
}

function setCurrentModule(doclet) {
if (doclet.kind === 'module') {
if (doclet.kind === 'module' && !doclet.isEnum) {
currentModule = new CurrentModule(doclet);
}
}
Expand Down
30 changes: 30 additions & 0 deletions packages/jsdoc/test/fixtures/enumtag4.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
ElementBefore = (function () {

/**
* Properties of a ElementBefore.
* @exports IElementBefore
* @interface IElementBefore
*/

return ElementBefore;
})();

/**
* ElementEnum enum.
* @exports ElementEnum
* @enum {string}
*/
ElementEnum = (function () {
return {};
})();

ElementAfter = (function () {

/**
* Properties of a ElementAfter.
* @exports IElementAfter
* @interface IElementAfter
*/

return ElementAfter;
})();
28 changes: 28 additions & 0 deletions packages/jsdoc/test/specs/tags/enumtag.js
Original file line number Diff line number Diff line change
Expand Up @@ -79,4 +79,32 @@ describe('@enum tag', () => {
expect(mymodule.kind).toBe('module');
});
});

describe('with items around it', () => {
const docSet4 = jsdoc.getDocSetFromFile('test/fixtures/enumtag4.js');

it('does not set memberof to item before', () => {
const elementBefore = docSet4.getByLongname('ElementBefore');

expect(elementBefore.memberOf).not.toBe('ElementEnum');
});

it('does not set make item after enum a member of the enum', () => {
const elementAfter = docSet4.getByLongname('module:ElementEnum~ElementAfter')[0];

expect(elementAfter).toBeUndefined();
});

it('does not set memberof to item after', () => {
const elementAfter = docSet4.getByLongname('ElementAfter')[0];

expect(elementAfter.memberOf).toBeUndefined();
});

it('sets scope to global for element after', () => {
const elementAfter = docSet4.getByLongname('ElementAfter')[0];

expect(elementAfter.scope).toBe('global');
});
});
});