62 Commits

Author SHA1 Message Date
Jeff Williams
5df4fd432d update the default template to generate pretty-printed source files (#208)
enabled by default. to disable pretty-printed source files, add the
property templates.default.outputSourceFiles: false to your conf.json
file.
2013-01-22 20:34:41 -08:00
Jeff Williams
b214687651 update package.json (including long-overdue change to version number) 2013-01-15 07:55:51 -08:00
Jeff Williams
35ac56fdd0 replace events and MD5 modules with equivalent Node.js shims
one notable change as a result: you now call emitter.emit() instead of
emitter.fire().
2012-10-30 22:49:04 -07:00
Jeff Williams
993d0fe49c create a fake async file I/O method (fs.readFile); use it in a test as a proof of concept 2012-10-23 22:06:33 -07:00
Jeff Williams
f7e8dee7af move JSHint to regular dependencies list
Technically, JSHint is only a dev dependency. But if you run `npm
install --dev git://github.com/jsdoc3/jsdoc.git`, npm tries to install
approximately every npm package that has ever existed, including many
that require gcc compilation.

This approach seems like the sanest workaround.
2012-10-17 09:15:23 -07:00
Jeff Williams
7085ec882c follow the Node.js convention and use a lowercase package name 2012-10-17 08:55:14 -07:00
Jeff Williams
3c8437b9d9 replace GFM parser; package.json cleanup 2012-10-16 09:16:20 -07:00
Jeff Williams
508e4776cb replace MD5 hash code 2012-10-16 07:54:19 -07:00
Jeff Williams
3b937e557f use underscore.js for templates instead of a customized subset 2012-10-16 05:34:50 -07:00
Jeff Williams
a82ba2b37c update jshint module; move to node_modules 2012-10-15 20:54:17 -07:00
Jeff Williams
da0a55e577 update 'wrench' module; move to node_modules 2012-10-15 06:01:39 -07:00
Jeff Williams
157d5c89ad update TaffyDB; move to node_modules 2012-10-15 05:22:13 -07:00
Jeff Williams
929e60dd99 update evilstreak markdown plugin; move to node_modules 2012-10-14 09:13:53 -07:00
Michael Mathews
1c6ff9421c Bumped revision number. 2012-08-15 21:56:06 +01:00
Jeff Williams
3be0356886 add self to contributors 2012-07-10 07:11:06 -07:00
Michael Mathews
23d03835f7 Fixed confusing readmes that implied the entire configuration JSON should be replaced by a few entries. Protected against exception thrown when some config entries were missing. Closes Issue #126 2012-06-15 07:59:21 +01:00
Michael Mathews
80211c4af0 Uptick revision number, minor changes to package.json 2012-06-10 08:16:19 +01:00
Michael Mathews
5900469526 Updated version from alpha to final candidate, authors and contributers added to the Jake template. 2012-05-14 17:20:08 +01:00
Jannon
6145b7ff69 Readme additions and pull request instructions
The primary change is the addition of the HOW_TO_CONTRIBUTE file detailing the best way to make it easy for maintainers to merge pull requests.
2012-04-21 03:14:29 -07:00
Rafał Wrzeszcz
8105cef501 Tutorials parsing. 2011-12-15 12:06:49 +01:00
Michael Mathews
ce435bed51 Members of enum automatically get a default value. 2011-10-27 00:20:33 +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
39667e6b47 Added test cases for @memberof! tag. 2011-10-15 20:46:12 +01:00
Michael Mathews
b25a6acce3 Fix for issue that caused plugins to be unable to be required when using a relative path to jsdoc. (hattip kived) See #37. 2011-10-14 21:05:48 +01:00
Michael Mathews
9b460f4621 Uptick revision number. 2011-10-13 23:38:26 +01:00
Michael Mathews
bf5d6eb505 Added plugin to escape HTML tags in descriptions. 2011-10-13 23:08:33 +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
5c47302493 Make display of private symbols optional. Closes #44. 2011-10-11 09:17:47 +01:00
Michael Mathews
df45f945b4 Fix for case where a @lends tag was on an object literal, and an anonymous @constructs tag was on a property would throw an error. 2011-10-06 21:34:13 +01:00
Michael Mathews
18d1472810 Fix for event names not being linked in the template output. 2011-10-02 22:07:08 +01:00
Michael Mathews
de4f31b46e Now support /*!* comments. Closes #26. 2011-09-23 22:04:53 +01:00
Michael Mathews
3bb9927039 Bumped revision number. 2011-09-14 23:43:24 +01:00
Michael Mathews
681078f68e Updated license and package info for beta release. 2011-09-05 20:01:20 +01:00
Michael Mathews
d083a879ce Symbols marked with @ignore are now filtered out of the published documentation. 2011-08-30 22:42:04 +01:00
Michael Mathews
90ac234799 Added some internal debugging features. FIX: Added initialiser for variable that sometimes caused an error to be thrown when it was undefined. Closes #24. 2011-08-30 08:41:41 +01:00
Michael Mathews
008905765d Bumped the revision number. 2011-08-29 20:53:19 +01:00
Michael Mathews
d5a0d3a3d9 Added Jake build script. 2011-06-18 12:52:24 +01:00
Michael Mathews
f7421592e2 Fixed bug that caused documenting built-in names like "constructor" to cause crash, and missing symbols from the template index. (Fixes #12). 2011-04-13 00:02:30 +02:00
Michael Mathews
95eebc9250 Changes
to improve debugging, added debugging notes to the README.
2011-04-12 21:49:40 +02:00
Michael Mathews
60b67732ac Updated README with information about dependencies. 2011-04-10 23:27:19 +02:00
Michael Mathews
20416aa65c Added support for @lends to the global. 2011-04-09 21:44:44 +02:00
Michael Mathews
813fd8ad63 Changed name of build folder to make compatible with NPM. 2011-03-29 22:13:49 +01:00
micmath
0c714c98f0 Improvements to default template: added navigation.
git-svn-id: https://jsdoc.googlecode.com/svn/trunk/@19 d5942f49-e6af-b5c1-9d01-85772c7ca168
2011-02-25 12:17:39 +00:00
micmath
54c0e0b8c0 Work on templates. Replaced mustache with Underscore Template code.
git-svn-id: https://jsdoc.googlecode.com/svn/trunk/@18 d5942f49-e6af-b5c1-9d01-85772c7ca168
2011-02-24 17:11:28 +00:00
micmath
b70a9bf0ef Fixed up default template more, added static files.
git-svn-id: https://jsdoc.googlecode.com/svn/trunk/@16 d5942f49-e6af-b5c1-9d01-85772c7ca168
2011-02-24 17:10:50 +00:00
micmath
6af99edab7 Added support for @typedef tag.
git-svn-id: https://jsdoc.googlecode.com/svn/trunk/@13 d5942f49-e6af-b5c1-9d01-85772c7ca168
2011-02-24 17:10:12 +00:00
micmath
d53971d2f3 Added support for the @also pragma, to allow multiple doclets to be associated with the same line of source code. Tweaks to the default template.
git-svn-id: https://jsdoc.googlecode.com/svn/trunk/@11 d5942f49-e6af-b5c1-9d01-85772c7ca168
2011-02-24 17:09:48 +00:00
micmath
334ea0b24b Update to build script to handle mirroring to svn.
git-svn-id: https://jsdoc.googlecode.com/svn/trunk/@8 d5942f49-e6af-b5c1-9d01-85772c7ca168
2011-02-05 23:00:00 +00:00
Michael Mathews
2facb898bf Additional tests for @borrows. 2011-01-30 15:54:07 +00:00