2625 Commits

Author SHA1 Message Date
Frank Steidinger
132a6da310 Prevent default template from trying to copy its static files into themselves if env.dirname contains a backslash. Otherwise they end up empty.
Filenames provided by fs.ls already use slashes instead of backslashes so the replace(fromDir, toDir) does nothing and the file is truncated. (Issue #190)
2012-09-20 12:35:27 +02:00
Michael Mathews
20f8709463 Fix for property tag being malformed. 2012-09-20 01:21:13 +01:00
Jeff Williams
3463a472a6 add FunctionNode reference to parser 2012-09-18 22:31:39 -07:00
Jeff Williams
bf84d3cd1d say that comments must have leading asterisks when using Markdown (#177) 2012-09-17 21:59:47 -07:00
Jeff Williams
4e0af2967a refactor default template and templateHelper.js (#186) 2012-09-17 21:50:26 -07:00
Jeff Williams
f1a104eb06 add helper function for debugging parse events 2012-09-16 11:37:56 -07:00
Jeff Williams
da485dff2c Merge pull request #182 from BobKerns/mingw
Make jsdoc script work with MinGW and Cygwin
2012-09-12 07:12:01 -07:00
Jeff Williams
6df6fafaf2 Merge pull request #183 from BobKerns/path-fix
Use the java facilities to handle path manipulations portably.
2012-09-12 07:04:50 -07:00
Bob Kerns
dc2ec62e70 Use the java facilities to handle path manipulations portably.
This was causing it to mis-calculate the paths, and end up losing the
output directory entirely, and overwrite the template static files
with themselves, resulting in truncation to zero-length. Of course,
they were also missing in the output.

It was expecting to be able to split paths on
System.getProperty("path.separator"), but that describes how to put a
path together, not how to take one apart, which is more complicated.

In particular, in windows, / is as valid a separator as \ in all but a
few UI contexts.

And since we need to pass / in paths that may get turned into URI's,
it's important to handle this correctly.

Java already provides a File facility to handle these sorts of operations.
This patch makes use of java.io.File to:

1) Find the parent of a File for dirname.
2) Find the name of a File for basename.

It also now makes use of substring for removing the ext for basename,
rather than Array.prototype.slice + join(""). I'm not sure what that
was all about...  It does have the effect of ensuring it's a Javascript
String, but calling String() has the same benefit and is much more clear.

You can put that back if there was a reason for it, but it looks just
confused to me.
2012-09-11 22:57:50 -07:00
Bob Kerns
3bf586ab5f Make the tests work under Cygwin
Under Cygwin, we need to be a bit more aggressive with replacing \ with /
to avoid \ in URIs internally. This shows up when running the tests with -T,
but not when running files directly, for reasons I don't fully understand.

This patch replaces the previous replacement of \ => / with one that happens
earlier and applies to all references, not just the URIs we construct.

Cygwin now passes jsdoc -T from any directory.
2012-09-11 19:38:50 -07:00
Bob Kerns
c3f8dab0d5 Make the tests work when run from other directories. 2012-09-11 19:35:12 -07:00
Bob Kerns
d8d61ee2d6 Make jsdoc script work with MinGW and Cygwin
On MinGW and Cygwin, we have different representations for pathnames,
neither of which Rhino understands. We also have to contend with '\',
which is not a legal URI character.

And we have to supply a third / after file:// (two before the null
hostname, and one before the start of the absolute path). Since Windows
paths don't start with /, we have to supply it in that case.

We handle the MinGW and Cygwin cases by asking for the information with
'pwd -W' for MinGW and 'cygpath $(pwd)' for Cygwin, before finally
falling back to pwd for everyone else. Then, if they don't start with '/'
we supply the extra '/' for the URL.
2012-09-11 18:54:47 -07:00
Jeff Williams
735bbd9182 make the tests pass again. note to self: run tests, THEN commit… 2012-09-09 21:15:58 -07:00
Jeff Williams
c8ce159342 use 'defaultvalue' property, not 'default', to hold the default value (closes #180) 2012-09-09 21:12:35 -07:00
Jeff Williams
e9a9dc988e if a child overrides an ancestor member, don't document the ancestor member (closes #158) 2012-09-09 20:06:49 -07:00
Jeff Williams
b3c717b8cb don't throw an exception if a parameter has no name (closes #175) 2012-09-09 13:44:19 -07:00
Jeff Williams
bf2fd75c3f use 'inherited' property in default template (closes #154) 2012-09-09 08:29:47 -07:00
Jeff Williams
09c77558d5 Merge pull request #178 from hegemonic/type-refactor
Refactor type parsing. Closes #118.
2012-09-09 08:01:56 -07:00
Jeff Williams
d6fedc82aa put the optional/nullable/variable/default properties in the right place 2012-09-09 07:58:27 -07:00
Jeff Williams
8622efd2ba Merge remote-tracking branch 'upstream/master' into type-refactor 2012-09-09 07:41:41 -07:00
Jeff Williams
e59dc9023a tests for doclets with Markdown asterisks 2012-09-09 07:18:13 -07:00
Jeff Williams
7c0d72415d Merge branch 'master' of git://github.com/DataTables/jsdoc into DataTables-master 2012-09-08 18:16:44 -07:00
Jeff Williams
d22d59b315 improve error message when "-d console" isn't used (closes #174); JSHint cleanup 2012-09-08 18:15:20 -07:00
Jeff Williams
7675640537 improve error message when template is missing (closes #171), plus minor cleanup 2012-09-08 18:00:16 -07:00
Jeff Williams
f5e3f0f31d save output in the current working directory, not the JSDoc directory 2012-09-03 10:23:25 -07:00
Allan Jardine
358dceac2c Fix jsdoc issue #172: Remove second call to unwrap. 2012-09-03 10:23:55 +01:00
Jeff Williams
ef6f2e92d5 use arrays instead of objects in Haruki template. fixes #153. (thanks to @kpozin for the fix!) 2012-08-22 20:07:33 -07:00
Jeff Williams
a3bf78410b Merge pull request #166 from hegemonic/exports-publish 2012-08-22 08:57:58 -07:00
Jeff Williams
4adeb03c56 Merge pull request #167 from hegemonic/augments-fix
Allow @augments to point at an undocumented dependency. Closes #160.
2012-08-19 19:16:21 -07:00
Jeff Williams
75071e9875 allow @augments to point at an undocumented dependency 2012-08-19 19:14:54 -07:00
Jeff Williams
2bf4af851d Merge pull request #165 from hegemonic/fs-path-fixes
Make 'fs' and 'path' modules closer to their Node.js equivalents
2012-08-19 16:56:01 -07:00
Jeff Williams
d091675cfa make 'fs' and 'path' modules more consistent with Node.js 2012-08-19 15:25:02 -07:00
Jeff Williams
56fa78573e keep track of which VM is running JSDoc 2012-08-19 15:17:56 -07:00
Jeff Williams
c643a6a1b9 Merge branch 'master' into type-refactor 2012-08-18 09:03:55 -07:00
Jeff Williams
9956be9bc8 Merge pull request #163 from hegemonic/lends-regexp
support lends tags in multiline doclets. closes #149.
2012-08-18 08:00:41 -07:00
Jeff Williams
33a41878b0 support lends tags in multiline doclets (fixed by @kpozin) 2012-08-18 07:58:01 -07:00
Jeff Williams
66dc90e75d Merge pull request #162 from hegemonic/lenient-fixes
suppress more errors in lenient mode (closes #159)
2012-08-18 07:36:54 -07:00
Jeff Williams
d04ed34612 in lenient mode, suppress as many exceptions as possible, logging errors to the console. closes #159. 2012-08-18 07:34:37 -07:00
Jeff Williams
39cb076e1a Merge remote-tracking branch 'upstream/master' into type-refactor 2012-08-17 14:21:01 -07:00
Michael Mathews
1c6ff9421c Bumped revision number. 2012-08-15 21:56:06 +01:00
Jakob Heuser
d61259a90c attempt to make npm compatible paths by removing node_modules as a path... darn you npm 2012-08-15 11:09:58 -07:00
Michael Mathews
425e56f835 Merge pull request #157 from manix84/master
Verbose Output
2012-08-12 13:45:19 -07:00
Michael Mathews
dcafed5d0c Merge pull request #156 from llaxsll/master
@partial Possibly this should be a core tag, but I think some time in the plugin incubator will be very useful, as a way to test it out and see how suitable it is for core. Thank you for contributing.
2012-08-12 13:43:18 -07:00
Rob Taylor
1cc0907aa4 Adding verboseOutput test. 2012-08-08 20:53:56 +01:00
Rob Taylor
6193b418f7 Removing newDoclet, as I don't think it's necessary. 2012-08-08 19:20:55 +01:00
Rob Taylor
a378c9f0b9 Removing _config, as it bleeds into global, and I don't like that.
Moved fileBegin and newDoclet back onto the handlers namespace of
exports.
2012-08-08 19:03:40 +01:00
Rob Taylor
ab31150d9a First init of verboseOutput plugin. 2012-08-08 16:25:53 +01:00
Michael Mathews
f4ea8f2d47 Merge pull request #151 from kpozin/fix-for-issue-150
Fix for #150: parsing doclets on object literal getters and setters
2012-07-26 15:20:04 -07:00
Ludo Antonov
29b8ab5ff4 Adding a plugin that enables a @partial tag for re-usable partial documentation kept in separate files. 2012-07-25 22:00:04 -07:00
Jeff Williams
45b24cc04c refactor type parsing; add tests 2012-07-15 15:40:40 -07:00