80 Commits

Author SHA1 Message Date
Jeff Williams
c095b6e20c add a strict validation option (defaults to true) that controls whether validation errors are fatal (issue #134) 2012-07-02 22:52:46 -07:00
Michael Mathews
6d914ee30e Added support for including README.md content on the output index page. Closes #128 2012-06-21 22:46:32 +01:00
Michael Mathews
c29e4e3309 Add support for default configuration values. Closes Issue #129. References Issue #126. 2012-06-21 21:09:40 +01:00
Michael Mathews
ef37251464 Fix for exception thrown when documenting symbols with special names like "hasOwnProperty". Closes #125. 2012-06-07 22:36:22 +01:00
Michael Mathews
810dd7f7fd Improved support for @alias when documenting inner classes as global. 2012-06-06 15:32:16 +01:00
Michael Mathews
1f6f4a7ee7 Added support for "include" and "exclude" of source files in the project configuration. Closes issue #56. 2012-06-01 00:00:02 +01:00
Jannon Frank
7d97a17421 Merge pull request #117 from jannon/SmartTestRunner
Upgrade testing framework
2012-05-06 03:59:43 -07:00
Michael Mathews
e0538ae011 Bugfix for exception thrown when the name of a member seen by the parser matches a name on the Object prototype. closes #116 2012-05-03 08:12:08 +01:00
Jannon
2d73440b3d Testing Framework Upgrade Part I
This first part of the testing framework upgrade:

- enhances the jsdoc script to allow switching to debug mode from the command line
- uses Jasmine to run tests
- adds flexibility to run tests from multiple root directories
- does automatic test discovery, so test files can just be created, dropped in an appropriate folder, and run without having to explicity add it to the test runner
- cleans up the test directory layout
- incorporates env.rhino.js which should make it easier to test templates
- is incomplete: this is just a savepoint.  About 1/3 of the tests have been converted.  The rest are still run through the old testrunner
2012-04-30 17:39:50 -07:00
Jannon
11aacdef1b Fix for valueOf key in object literals
This is a test (provided by julienbachmann) and a fix for an issue where the parser crashes when valueOf is used as a key in an object literal
2012-04-21 04:04:48 -07:00
Jannon Frank
dfd5955719 Merge pull request #100 from jannon/ExtendsTypeFix
Allow braces for @extends values (e.g. {Type})
2012-03-21 02:03:58 -07:00
Jannon
64ae4c013b Allow braces for @extends values (e.g. {Type})
Fixes#96.  Includes test
2012-03-21 01:58:41 -07:00
Jannon
9896096b88 Test and fix for #84 2012-03-21 00:02:44 -07:00
Jannon
00f3ed8dc6 typo fix in template helper and changes for split path and filename in doclet.meta 2012-03-16 03:06:26 -07:00
Jannon
28d0af0749 Separate doclet.meta.filename into doclet.meta.path and doclet.meta.filename when appropriate 2012-03-16 02:44:32 -07:00
Jannon Frank
eeb6611ea5 Merge pull request #78 from rafalwrzeszcz/feature-template-helper
Feature template helper
2012-03-16 01:56:53 -07:00
Jannon
026d1ac0fa The name collision solution from rafalwrzeszcz (#73) 2012-03-16 00:51:36 -07:00
Jannon
ecf2cfba3c Fix the recursive alias resolve test and track global variables so global aliases can be resolved 2012-03-15 22:13:08 -07:00
Jannon
a2259ac14c adding recursive alias resolving from rafalwrzeszcz 2012-03-15 20:09:50 -07:00
Jannon Frank
51d148fddd Merge pull request #83 from tschaub/extends
Properly inherit members from grandparents.
2012-03-15 17:49:29 -07:00
Jannon Frank
282da00517 Merge pull request #86 from jannon/FilesForAll
Always making source file list available to templates
2012-03-15 17:48:46 -07:00
Jannon
e35ef82d99 A different take on a more flexible parser/plugin architecture
Plugins can now do any or all of three things:
- Add tags to the dictionary by exporting a 'defineTags' function
- Register event handlers like before, but exporting them in a 'handlers' object.
- Add a node visitor to the parser.  As the parser visits nodes, it will give all attached plugin visitors an opportunity to process the node as well.  This gives plugin creators an opportunity to do things with symbols that the standard parser doesn't handle (like class factory function calls)

This includes a new Rhino jar just for JSDoc3!  Well, it just has a small change that causes Rhino's parser to attach jsdoc comments to function call nodes when present.
2012-02-24 05:53:03 -08:00
Jannon
9ec3d61084 Revert "Refactored parsing to allow for easily extending/overriding parseing behavior"
This reverts commit f52302e71d5d9754f5ce1d193b0ba4cda133d566.
2012-02-23 17:18:37 -08:00
Jannon
7b12033b5a Always making source file list available to templates
Previously, the list of source files was only added to a package doclet and passed through to the templates if there was a package.json specified.  Now, that doclet is always added.  If there is no package.json, then only the 'files' property of the doclet will be defined.
2012-02-22 14:27:06 -08:00
Tim Schaub
625a2812f0 Properly inherit members from grandparents.
Previously, inheritance only worked one level deep.  With this change, inherited members are added to the docs after processing each doclet.  This allows for proper inheritance to an arbitrary depth.
2012-02-04 11:49:10 -07:00
Jannon
f52302e71d Refactored parsing to allow for easily extending/overriding parseing behavior 2012-01-25 14:17:22 -08:00
Rafał Wrzeszcz
84b44480ba Improved template engine. 2012-01-04 10:48:41 +01:00
Rafał Wrzeszcz
ac02928d3d Tutorials support in template. 2011-12-15 13:21:52 +01:00
Rafał Wrzeszcz
f6216e6d28 Support for @tutorial tag (both DocBlock and inline). 2011-12-15 12:47:56 +01:00
Rafał Wrzeszcz
8105cef501 Tutorials parsing. 2011-12-15 12:06:49 +01:00
Rafał Wrzeszcz
13526499cf Tutorials base structure. 2011-12-15 10:02:05 +01:00
Rafał Wrzeszcz
5aca2ce33a Mark inherited methods. 2011-12-13 10:38:25 +01:00
Rafał Wrzeszcz
2524664d4b Dropped template default parameter. 2011-12-11 14:12:42 +01:00
Michael Mathews
62157919d2 Merge pull request #66 from rafalwrzeszcz/feature-tag-abstract
@abstract/@virtual tag support.
2011-12-11 02:45:57 -08:00
Rafał Wrzeszcz
fa7825a42b Changed default parameter value. 2011-12-10 23:29:17 +01:00
Rafał Wrzeszcz
fcc26990ca @abstract/@virtual tag support. 2011-12-10 10:27:33 +01:00
Michael Mathews
d7e74062b1 Fixed issue that caused members of named function statements to have the wrong memberof attributes generated by the parser. Closes Issue #60. 2011-11-20 22:12:51 +00:00
Michael Mathews
8952a5ee17 Fixed issue that caused named doclets with properties to not have the names of the properties resolved correctly. 2011-11-16 22:59:23 +00:00
Michael Mathews
ce435bed51 Members of enum automatically get a default value. 2011-10-27 00:20:33 +01:00
Michael Mathews
2351776bdf Members of an @enum no longer require doc comments to appear in the documentation. 2011-10-26 23:50:57 +01:00
Michael Mathews
1abe982e2f Added feature: @lends doc comments can now appear before the return statement, when lending a returned object literal. 2011-10-21 00:01:34 +01:00
Michael Mathews
3175288d63 Added feature: if omitting the name of a @param, JSDoc will use the name from the parameter list in the source code. 2011-10-20 23:15:40 +01:00
Michael Mathews
ab9d00186c Added support for displaying @constant docs in the default template. 2011-10-18 23:38:37 +01:00
Michael Mathews
39b5e09bb6 Fixed issue that caused incorrect longname to be calculated when a @memberof tag was applied to a constructor nested within another constructor. 2011-10-15 16:15:19 +01:00
Michael Mathews
134227b6d4 Added support for @variation tag. 2011-10-14 20:41:06 +01:00
Michael Mathews
bd7a5631c1 Fixed error in reporting the line number of some symbols found in the source code. Closes #48. 2011-10-13 22:59:19 +01:00
Michael Mathews
a9963a0167 Fixed incorrect intrapage links for events. Closes #38. 2011-10-12 22:54:36 +01:00
Michael Mathews
181a483389 Better error message for missing value attached to @property tags. Closes #46. 2011-10-12 21:28:38 +01:00
Michael Mathews
c89fa6dbba Added new event named "beforeParse". Closes #45. 2011-10-11 20:13:30 +01:00
Michael Mathews
5c47302493 Make display of private symbols optional. Closes #44. 2011-10-11 09:17:47 +01:00