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

Added additional test for alias.

Browse Source
This commit is contained in:
Michael Mathews 2011-01-25 19:19:49 +00:00
parent 9fa998f5e3
commit 5d9e175778
4 changed files with 4 additions and 56 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

51
changes.md
View File

@ -1,51 +0,0 @@
Defining the Namepath of an Inner Symbol
---
[change] The namepath of an inner symbol is now delimited by the tilde character
instead of the dash. If you wrote `@name Myclass-innerProperty` in version 2,
you would write `@name Myclass~innerProperty` in version 3. This change was
added to avoid conflicts with the new symbol categories of "module" and "file",
both of which have names corresponding to their file paths; the dash character
is common in filepaths.
Allowing Strings in Namepaths
---
[new] If a section of a namepath is meant to be atomic, that is it should always
be kept together and its inner characters _not_ interpretted, you can surround
that section with quotes. For example the hash character normally has special
meaning within a namepath, but here we tell JSDoc to treat "#channel" as an
uninterpretted, atomic string in the namepath.
/**
@namespace
@name chat."#channel"
*/
chat['#channel'] = {};
/**
@property
@type {boolean}
@name chat."#channel".open
*/
chat['#channel'].open = true;
Support For E4X
---
[new] As a benefit of using Rhino's own JavaScript parser, JSDoc has inherited
the ability to parse any source code that Rhino can parse, including the latest
syntax patterns like E4X (ECMAScript for XML).
Defining Multiple Types
---
[change] When writing any type expression that is made up of multiple types in
version 3 you must use the pipe character as a separator. Pipes or commas were
allowed in version 2. This change was made to increase compatibility with type
unions in the Google Closure Compiler.
/**
@type {string|Object.<string, string>}
*/

3
conf.json
View File

@ -7,8 +7,7 @@
"includePattern": ".+\\.js(doc)?$"
},
"//": "Add paths to any plugin files you want applied. like: plugins/markdown.js",
"plugins": [
],
]
}

2
main.js
View File

@ -219,7 +219,7 @@ function main() {
require('jsdoc/src/handlers').attachTo(app.jsdoc.parser);
docs = app.jsdoc.parser.parse(sourceFiles, env.opts.encoding);
//dump(docs); exit(0);
dump(docs); exit(0);
if (env.opts.expel) {
dump(docs);
exit(0);

4
test/runner.js
View File

@ -86,11 +86,11 @@ testFile('test/t/cases/inner.js');
testFile('test/t/cases/modules/data/mod-1.js');
testFile('test/t/cases/modules/data/mod-2.js');
testFile('test/t/cases/accesstag.js');
testFile('test/t/cases/alias.js');
testFile('test/t/cases/alias2.js');
testFile('test/t/cases/alias3.js');
testFile('test/t/cases/augmentstag.js');
testFile('test/t/cases/accesstag.js');
testFile('test/t/cases/authortag.js');
testFile('test/t/cases/classtag.js');
testFile('test/t/cases/constructstag.js');