179 Commits

Author SHA1 Message Date
Jeff Williams
3b74b7b83c don't throw errors for unnamed properties (#373) 2013-04-06 17:37:54 -07:00
Jeff Williams
e5be860cc4 support modules that export a single non-constructor function (#384) 2013-04-06 16:53:20 -07:00
Jeff Williams
450f3944bc Merge pull request #361 from Billiam/fix/repeated-class-header-354
Fix repeated classes header in sidenav
2013-04-06 07:29:53 -07:00
Jeff Williams
cfff8dd035 identify repeatable params in the default template (#381) 2013-04-02 08:41:05 -07:00
Billiam
5a84918099 Fix repeated classes header in sidenav
Fixes multiple <h3>classes</h3> navigation menus appearing in navigation
sidebar when using modules.

Removes magic -1 value and module counting in favor of more explicit
boolean, only appending class heading if necessary.
2013-03-11 10:42:11 -05:00
Jeff Williams
f09ef82246 don't throw an exception if there are no source files with JSDoc comments (#329) 2013-01-30 17:31:05 -08:00
Jeff Williams
434c80e803 turn '@author' tag text into mailto: link where possible (#326) 2013-01-28 07:33:07 -08:00
Jeff Williams
7d4dd38902 store version info in env.version, and display version number in default template output (#321) 2013-01-27 21:07:23 -08:00
Jeff Williams
4c1611f86f fix class signatures 2013-01-23 23:29:52 -08:00
Jeff Williams
a693262c66 handle typedefs that contain functions (#292) 2013-01-23 22:03:29 -08:00
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
997cfe9f9a convert tabs to spaces 2013-01-22 17:45:21 -08:00
Jeff Williams
adcb06ca56 include global typedefs and events in template output; don't put "undefined" into typedef headers (#292) 2012-12-27 07:41:38 -08:00
Jeff Williams
d73570defc make fs module consistent with Node.js (#211) 2012-12-26 19:03:05 -08:00
Jeff Williams
a17c90dfd2 deprecate env.dirname in favor of __dirname (#286)
plus some minor cleanup to address JSHint warnings
2012-12-23 09:45:11 -08:00
Jeff Williams
f79728ed62 Merge pull request #281 from mathematicalcoffee/template-event-list-in-index
Default template: Event list in right hand sidebar
2012-12-21 23:11:30 -08:00
Jeff Williams
b07d19f43a show complete info for global functions on Global page (#285) 2012-12-21 11:39:36 -08:00
mathematicalcoffee
4cf3598c4c Added list of events to the index. 2012-12-11 10:47:33 +10:00
Jeff Williams
2c597b6505 omit signature from event name headings (#266) 2012-12-02 12:11:58 -08:00
Jeff Williams
2de416da7d fix broken hrefs in output files (#264) 2012-12-02 08:03:54 -08:00
Jeff Williams
d5991a2d71 don't overwrite pages like 'index.html' if a namespace has a name like 'index' (#244)
also, improved the default template's efficiency--we now create lists
of all classes/members/etc. just once, instead of once per longname
2012-11-08 07:47:05 -08:00
Mark Wang
ea7f8cb408 Fix #253 2012-11-06 18:22:43 -08:00
Matthew Kastor
efaeea4d24 Moved css files into prettyPrintSource template
The three css files moved were not used by the default template. I only
had them there so the prettyPrintSource plugin would work. Since plugins
can use templates without ruining everything I've moved the css files to
their proper place and copy them over in
templates\prettyPrintSource\publish.js This makes it possible to enable
the plugin and get the same results with any template. Now all I need to
figure out is how to inject links to the generated pages into the
docs...
2012-10-20 23:13:16 -04:00
Jeff Williams
65e4a47201 Merge branch 'master' of https://github.com/jsdoc3/jsdoc
Conflicts:
	plugins/prettyPrintSource.js
2012-10-20 15:37:54 -07:00
Jeff Williams
3f60724f92 fix JSHint errors (again) 2012-10-20 15:36:59 -07:00
Matthew Kastor
202357d4d0 jslint doesn't like comment switches
The block is toggled by deleting /*
/*// Explanation of junk
somejunk
//*/
2012-10-20 18:34:55 -04:00
Matthew Kastor
7ebf9c5976 prettyPrintSource now uses it's own template
now that the templates.js file is fixed, plugins can use templates
without trashing everything.
2012-10-20 18:20:33 -04:00
Matthew Kastor
b05e3bf147 Merge pull request #233 from matthewkastor/Fix-for-issue-#228-Pretty-Source
Adds Pretty Printed Source Code To Docs
2012-10-19 14:26:37 -07:00
Matthew Kastor
77e2bd5f7a Adds Pretty Printed Source Code To Docs
Plugin generates pages using google prettify to highlight the source.
The three css files are the defaults that come with google prettify. The
plugin is set up to use the desert style as it's default stylesheet,
with prettify, sunburst and prettify-jsdoc listed as alternative
stylesheets.

Currently this plugin is not tied in with any template. There won't be
links in the documentation to bring you to the prettified source.
2012-10-17 03:21:10 -04:00
Jeff Williams
3b937e557f use underscore.js for templates instead of a customized subset 2012-10-16 05:34:50 -07:00
Jeff Williams
bdee90463f replace JSON-to-XML serializer 2012-10-15 20:47:08 -07:00
Jeff Williams
157d5c89ad update TaffyDB; move to node_modules 2012-10-15 05:22:13 -07:00
Jeff Williams
10a54620fc use consistent path separators on windows (#207) 2012-10-04 09:20:44 -07:00
Jeff Williams
716adbabf3 fix error in exceptions template (#199) 2012-09-23 21:15:46 -07:00
Jeff Williams
ec47356ee6 make templates work from relative and absolute paths (#196, #197, #198) 2012-09-23 21:06:36 -07:00
Jeff Williams
add0b09638 don't show "type" section if there are no types to display (#195) 2012-09-22 11:22:01 -07:00
Jeff Williams
c890b0cf79 replace SHJS syntax highlighter with prettify.js (#193) 2012-09-21 14:17:12 -07:00
Jeff Williams
c20f399d1d show type of events; link to type of return values (#192) 2012-09-21 11:11:47 -07:00
Michael Mathews
3bdd67e737 Merge pull request #191 from steidinger/template-overwrites-css-files
Proposed fix for Issue #190 (default template truncates CSS files on Windows)
2012-09-20 14:49:47 -07:00
Jeff Williams
6b95d8b29d replace broken tag in tutorial template (#188) 2012-09-20 08:06:34 -07:00
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
Jeff Williams
4e0af2967a refactor default template and templateHelper.js (#186) 2012-09-17 21:50:26 -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
d22d59b315 improve error message when "-d console" isn't used (closes #174); JSHint cleanup 2012-09-08 18:15:20 -07:00
Jeff Williams
f5e3f0f31d save output in the current working directory, not the JSDoc directory 2012-09-03 10:23:25 -07: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
d091675cfa make 'fs' and 'path' modules more consistent with Node.js 2012-08-19 15:25:02 -07:00
Jeff Williams
c43c183aaa disable JSHint's "asi" relaxing option 2012-07-06 07:40:24 -07:00