diff --git a/package.json b/package.json index 4313e09b..f83ab3c3 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,7 @@ { "name": "JSDoc", "version": "3.0.0alpha", - "revision": "1316040176608", + "revision": "1316811854469", "description": "An automatic documentation generator for javascript.", "keywords": [ "documentation", "javascript" ], "licenses": [ diff --git a/rhino_modules/jsdoc/src/parser.js b/rhino_modules/jsdoc/src/parser.js index 5461ef33..b2fa3710 100644 --- a/rhino_modules/jsdoc/src/parser.js +++ b/rhino_modules/jsdoc/src/parser.js @@ -120,7 +120,9 @@ function pretreat(code) { // merge adjacent doclets .replace(/\*\/\/\*\*+/g, '@also') // make lent objectliterals documentable by giving them a dummy name - .replace(/(\/\*\*[\s\S]*?@lends\b[\s\S]*?\*\/\s*)\{/g, '$1____ = {'); + .replace(/(\/\*\*[\s\S]*?@lends\b[\s\S]*?\*\/\s*)\{/g, '$1____ = {') + // make starbangstar comments look like real jsdoc comments + .replace(/\/\*\!\*/g, '/***'); } /** diff --git a/test/cases/starbangstar.js b/test/cases/starbangstar.js new file mode 100644 index 00000000..a0456352 --- /dev/null +++ b/test/cases/starbangstar.js @@ -0,0 +1,7 @@ +/** +* Script that does something awesome +* +* @copyright (c) 2011 Rotorz Limited. All rights reserved. +* @author Lea Hayes +* @module myscript/core +*/ \ No newline at end of file diff --git a/test/runner.js b/test/runner.js index 31a86747..344d517c 100644 --- a/test/runner.js +++ b/test/runner.js @@ -147,6 +147,7 @@ testFile('test/t/cases/requirestag.js'); testFile('test/t/cases/returnstag.js'); testFile('test/t/cases/seetag.js'); testFile('test/t/cases/sincetag.js'); +testFile('test/t/cases/starbangstar.js'); testFile('test/t/cases/thistag.js'); testFile('test/t/cases/typekind.js'); testFile('test/t/cases/typetag.js'); diff --git a/test/t/cases/starbangstar.js b/test/t/cases/starbangstar.js new file mode 100644 index 00000000..0f040ff5 --- /dev/null +++ b/test/t/cases/starbangstar.js @@ -0,0 +1,9 @@ +(function() { + var docSet = testhelpers.getDocSetFromFile('test/cases/starbangstar.js'), + mod = docSet.getByLongname('module:myscript/core')[0]; + + test('When doclet starts wuth /*!* it, it is treated as a JSDoc comment.', function() { + assert.equal(mod.description, 'Script that does something awesome'); + }); + +})(); \ No newline at end of file