2040 Commits

Author SHA1 Message Date
Jeff Williams
0a776648bf whitespace 2014-12-07 20:32:53 -08:00
Jeff Williams
5b5d90f165 remove busted AppVeyor config 2014-12-07 18:11:41 -08:00
Jeff Williams
eafc56de23 revert part of 5fa636 due to performance hit (#830) 2014-12-07 16:37:28 -08:00
Jeff Williams
3162215c9a improve the way we handle namespaces 2014-12-07 13:51:48 -08:00
Jeff Williams
e02ed2f7fe correct docs 2014-12-07 13:03:43 -08:00
Jeff Williams
c0b7b784a2 minor cleanup 2014-12-07 13:01:31 -08:00
Jeff Williams
5fa636ab7b create doclets for mixed-in symbols (#378)
Also includes a fair amount of cleanup.
2014-12-07 11:05:56 -08:00
Jeff Williams
5a92f5eff7 update committed version of Catharsis (#705) 2014-12-06 17:12:39 -08:00
Jeff Williams
de6650023f bump revision 2014-12-06 17:09:49 -08:00
Jeff Williams
c59d949c6b bump Catharsis version to support JSDoc-style nested arrays, like string[][] (#705) 2014-12-06 17:09:14 -08:00
Jeff Williams
ee2badcde2 improvements from @dchambers to nav-building code (#813)
Squashed commit of the following:

commit 723349a9c90a005137d01e19012778f4dddb1d12
Author: dchambers <dominic.chambers@gmail.com>
Date:   Fri Dec 5 13:14:13 2014 +0000

    Moved an assignment within the corresponding guard, since it was superfluous unless the guard was triggered.

commit 872974656e7500c99daba64e7db31f14f9874c0d
Author: dchambers <dominic.chambers@gmail.com>
Date:   Fri Dec 5 11:35:33 2014 +0000

    Use four spaces for tabulation.

commit 5eaabcf84c5395aeeeff018ea042e73d710e2846
Author: dchambers <dominic.chambers@gmail.com>
Date:   Mon Nov 24 18:15:36 2014 +0000

    Attempt to fix remaining linting errors -- may not work as I'm unable to run the build locally on my own machine to verify.

commit 0137865ff4aa4e888533a217f2e6bb3b12b7fc87
Author: dchambers <dominic.chambers@gmail.com>
Date:   Mon Nov 24 17:42:09 2014 +0000

    Attempt to fix remaining linting errors -- may not work as I'm unable to run the build locally on my own machine to verify.

commit 7d80410d63e29837b436776b8983004c8b92ecb2
Author: dchambers <dominic.chambers@gmail.com>
Date:   Mon Nov 24 17:17:51 2014 +0000

    Removed trailing whitespace from 'publish.js'.

commit 773b785756f5ee6c32cbcb1742543c1a2671efe7
Author: Dominic Chambers <dominic.chambers@gmail.com>
Date:   Tue Aug 26 09:58:50 2014 +0100

    Ensure the title for classes defined within modules shows the thing
    being documented as being a class rather than a module, as it currently
    does for interfaces.

commit 9fc527d63aa6839fbae07f4b6db8dee027f6fc43
Author: Dominic Chambers <dominic.chambers@gmail.com>
Date:   Tue Aug 26 09:51:10 2014 +0100

    Remove the 'module:' prefix from index links to classes and interfaces
    defined within modules.

commit 21e3e31f2499bbc9cb5f10c09cfaeb86d25ded9b
Author: Dominic Chambers <dominic.chambers@gmail.com>
Date:   Tue Aug 26 09:43:13 2014 +0100

    Removed duplicated code from the buildNav() function, where the version
    of the code used is one where items are only written if they haven't
    already been encountered, and a heading is only written when there are
    items to appear beneath that heading.
    Conflicts:
    	templates/default/publish.js
2014-12-06 15:50:28 -08:00
Jeff Williams
78ed79c49a attempt to fix AppVeyor config file 2014-12-03 09:53:13 -08:00
Jeff Williams
e8a35e686e add AppVeyor config for Windows CI build 2014-12-03 09:34:53 -08:00
Jeff Williams
9c1ed61949 bump revision 2014-12-03 09:32:35 -08:00
Jeff Williams
1865e51d0a remove useless function 2014-12-01 20:10:24 -08:00
Jeff Williams
b5c4e202d9 fix dumper issue when Set is available (#811) 2014-11-28 19:18:21 -08:00
Jeff Williams
42104c82ee enable lint-checking for tests; delint/cleanup tests 2014-11-28 18:36:04 -08:00
Jeff Williams
f135456396 don't overwrite the classdesc tag's value when the class and constructor tags are also present (#806) 2014-11-27 11:48:11 -08:00
Jeff Williams
0daeb2e947 improve dumper module and global dump function (#811)
- Fixed an issue in the dumper module that caused non-circular references between objects to be treated as circular references. For example, in an array of objects A and B, if B.a refers to A, the value of B.a can now be dumped.
- The dumper module is now much faster when the built-in class `Set` is not available.
- The global dump function is now much faster and is less likely to dump the value `<CircularRef>`.
2014-11-27 10:03:26 -08:00
Jeff Williams
f302234811 delint; cleanup 2014-11-27 09:48:07 -08:00
Jeff Williams
1a975c0f6d remove duplicate Requires section in modules (#790) 2014-11-11 20:14:38 -08:00
Jeff Williams
42f388f009 render a doclet's overrides property (#792) 2014-11-11 18:01:17 -08:00
Jeff Williams
afbc4fa0bc close li tag 2014-11-11 17:55:16 -08:00
Jeff Williams
b22a8a20c6 add overrides property to doclets that override other symbols (#792) 2014-11-11 17:09:37 -08:00
Jeff Williams
93cfe292ef delint 2014-11-11 16:50:37 -08:00
Jeff Williams
7807ac021e rename "Index" to "Home" (#750)
Thanks to @dchambers for the suggestion.
2014-11-08 10:54:14 -08:00
Jeff Williams
36065d22e8 add exception/throws to default tag list for Markdown plugin (#736)
Plus some test refactoring.

Thanks to @otakustay for suggesting this change.
2014-11-07 15:18:07 -08:00
Jeff Williams
8f1d892fbf ensure that filenames do not start with an underscore (#758)
Squashed commit of the following:

commit 11da3dbe026fb0c76d619f0295a195d1f012462e
Author: Jeff Williams <jeffrey.l.williams@gmail.com>
Date:   Fri Nov 7 14:42:02 2014 -0800

    add test for #758

commit f3e001d549c5e0e69e50b231f375da92f3e8f688
Merge: df1f4bd d551131
Author: Jeff Williams <jeffrey.l.williams@gmail.com>
Date:   Fri Nov 7 14:32:30 2014 -0800

    Merge remote-tracking branch 'danorton/patch-1' into 758

commit d5511316468eb93f852c51fab5eec380bcfee4b4
Author: Daniel Norton <daniel@danielnorton.com>
Date:   Wed Sep 3 17:00:49 2014 -0500

    Prevent filenames beginning with underscore

    A lot of related software (most notably github.io and the default configuration of jsdoc itself) ignores files with names that begin with an underscore, but the makeUniqueFilename() creates such filenames when the incoming filename is blank. This patch modifies makeUniqueFilename() to insert the ASCII letter "X" before empty filenames or filenames that begin with an underscore.
2014-11-07 14:42:16 -08:00
Jeff Williams
df1f4bda22 treat foo="bar" as a non-optional version of [foo="bar"] (#791) 2014-11-06 20:51:13 -08:00
Jeff Williams
d17ecfd8ec remove cruft from Tag objects 2014-11-06 20:28:34 -08:00
Jeff Williams
bfddc53034 Merge pull request #802 from cdparks/fallback-to-regex
Falling back to regex solution for default value when value is malformed
2014-11-06 08:49:40 -08:00
Christopher D. Parks
768a61c630 Falling back to regex solution for default value when value is malformed
Added the following tests which fail without the patch and pass with it:
    1) should fail gracefully when the default value has an unmatched bracket
    2) should fail gracefully when the default value has an unmatched quote
2014-11-05 18:01:55 -08:00
Jeff Williams
5cff804eac detab 2014-11-05 16:56:25 -08:00
Jeff Williams
7761292b97 use nicer typography in the default template (#780)
Squashed commit of the following:

commit eb310340ae542152ae5fd15b070e389a17b71913
Author: Dominic Chambers <dominic.chambers@gmail.com>
Date:   Wed Nov 5 17:24:19 2014 +0000

    Updated to use the same set of monospace typefaces as MDN too.

commit 5ff2591f8c3711e20f87eeb2e41347396d201414
Author: Dominic Chambers <dominic.chambers@gmail.com>
Date:   Wed Nov 5 17:15:28 2014 +0000

    Add font re-generation instructions to the README.

commit bb4502a308936a31684732104b09ae737e6fbaec
Author: Dominic Chambers <dominic.chambers@gmail.com>
Date:   Wed Nov 5 16:11:06 2014 +0000

    Added additional variations of the OpenSans typeface.

commit 125f2c91e767c7fa853ffa3222e7ed7d02f027b8
Author: Dominic Chambers <dominic.chambers@gmail.com>
Date:   Wed Nov 5 15:33:44 2014 +0000

    Moved the web fonts into a separate 'fonts' directory.

commit 968998c677a946e79910b96cff2cb4c29898eb48
Author: Dominic Chambers <dominic.chambers@gmail.com>
Date:   Wed Nov 5 15:24:46 2014 +0000

    Removed a negative margin hack we no longer seem to need.

commit 82f96d67cd3067ba6fd3deadee13e8853eb58491
Author: Dominic Chambers <dominic.chambers@gmail.com>
Date:   Wed Nov 5 15:13:15 2014 +0000

    Removed the 'Summary' heading, plus re-jigged the formatting so there isn't too much space before the content.

commit db9dfad5c2339ea6d36a400b59da0447d446920d
Author: Dominic Chambers <dominic.chambers@gmail.com>
Date:   Wed Nov 5 14:23:05 2014 +0000

    Fix for styling that was incorrectly being applied to each item in a list, rather than to the list itself.

commit 774271bd4e74ea429df7e5ae8fb9473097b81a1b
Author: Dominic Chambers <dominic.chambers@gmail.com>
Date:   Wed Nov 5 14:14:04 2014 +0000

    For consistency, ensure there is always a space after the colon used to delimit CSS rule pairs.

commit 88d59794b0442e594bedf6fb17a638923ac67c2a
Author: Dominic Chambers <dominic.chambers@gmail.com>
Date:   Wed Nov 5 14:07:31 2014 +0000

    Replace tabs with spaces to be consistent with the remainder of the stylesheet.

commit 37e5043403441a19cbe0cf2e2f4dec8ceba6cacb
Author: Dominic Chambers <dominic.chambers@gmail.com>
Date:   Wed Nov 5 14:02:34 2014 +0000

    Use the same color for headings that MDN does.

commit 8f925659efd7a6c9996bf2a8dcebb174f79dc8d8
Author: Dominic Chambers <dominic.chambers@gmail.com>
Date:   Fri Aug 22 09:46:41 2014 +0100

    Accidentally missed from previous check-in.

commit e98b060822b018c1403b98c92400052565d69e20
Author: Dominic Chambers <dominic.chambers@gmail.com>
Date:   Fri Aug 22 09:46:11 2014 +0100

    Updated the license to reflect the inclusion of the Open Sans typeface,
    plus included EOT and SVG versions of the font so that older version of
    IE and Android browser also get to see the page rendered correctly.

commit 7e1a581bca931603e738e5afc238e7f211c9d444
Author: Dominic Chambers <dominic.chambers@gmail.com>
Date:   Thu Aug 21 14:32:02 2014 +0100

    Rebased the template typography off of the Mozilla Developer Network
    site so generated API docs have a more contemporary and familiar style.
2014-11-05 16:48:09 -08:00
Jeff Williams
1f71ae090e fix bad test case 2014-11-03 15:19:14 -08:00
Jeff Williams
06acc6697a optionally scan tutorials directory recursively (#712)
Squashed commit of the following:

commit 5be2cb3103521d2ca1a14c24d4ccd776c1f2a5d9
Author: Jeff Williams <jeffrey.l.williams@gmail.com>
Date:   Mon Nov 3 14:29:29 2014 -0800

    make tutorials respect the --recurse option; refactor modules to facilitate testing; improve tests

commit 9af57751385439ceee3fac8f698a747a745c7c2b
Merge: 5399745 97a8ab0
Author: Jeff Williams <jeffrey.l.williams@gmail.com>
Date:   Sat Nov 1 19:00:43 2014 -0700

    Merge remote-tracking branch 'koalazak/master' into 712

    Conflicts:
    	lib/jsdoc/opts/args.js

commit 97a8ab000b567c220525cc179c2f45b626236933
Author: zak <zak@ultra>
Date:   Mon Jul 21 15:28:20 2014 -0300

    Removed command-line option -U to recursive. Now is default. Added tests.

commit a79c9c9dac4eeb784e3f22b1da073c2af5b014cc
Author: zak <zak@ultra>
Date:   Thu Jul 17 13:28:38 2014 -0300

    Recurse 5 levels

commit 349d10e528d6ba797fd745e31e1e358ddcf26857
Author: koalazak <facu@Cacahuate.local>
Date:   Wed Jul 16 22:30:41 2014 -0300

    Travis CI ready ready

commit ffde2bf4bdc2bd0ba2daa20a58540e4a2dd099e8
Author: koalazak <facu@Cacahuate.local>
Date:   Wed Jul 16 22:22:56 2014 -0300

    Travis CI ready

commit 3e439151fb58d530abe294f1cc499e5fab7b8fe8
Author: koalazak <facu@Cacahuate.local>
Date:   Wed Jul 16 21:47:22 2014 -0300

    Optionally scan tutorials directory recursively

    I do not want to have a directory of tutorials. I need to have the
    tutorials distributed throughout the project. I have one in each
    "package" folder.
2014-11-03 14:30:21 -08:00
Jeff Williams
5399745a97 allow default values for parameters to contain brackets (#640)
Squashed commit of the following:

commit 5363a9850f1279c1ea5f916455899479aca71261
Author: Jeff Williams <jeffrey.l.williams@gmail.com>
Date:   Sat Nov 1 15:13:33 2014 -0700

    DRY out; delint; remove unused capture group

commit e3066068f91ba5f2c920cb5389eae15ac70f45aa
Author: Christopher D. Parks <christopher.daniel.parks@gmail.com>
Date:   Fri Apr 25 16:32:20 2014 -0700

    Add missing semi-colon caught by eslint

commit 7bd864eecba67df99bae7b338685bf6cf31e2516
Author: Christopher D. Parks <christopher.daniel.parks@gmail.com>
Date:   Fri Apr 25 16:14:12 2014 -0700

    Adding tests for fix #640

    Without the fix, we get the following when running ./jsdoc -T
        Failures:

        jsdoc/name splitName

          1) should allow default values to have brackets
          Message:
            Expected '[path=["home",' to be '[path=["home", "user"]]'.
          Stacktrace:
            undefined

          2) should allow default values to have brackets
          Message:
            Expected '"user"]] - Path split into components' to be 'Path split into components'.
          Stacktrace:
            undefined

          3) should allow default values to have brackets inside strings
          Message:
            Expected '[path=["Unmatched' to be '[path=["Unmatched begin: ["]]'.
          Stacktrace:
            undefined

          4) should allow default values to have brackets inside strings
          Message:
            Expected 'begin: ["]] - Path split into components' to be 'Path split into components'.
          Stacktrace:
            undefined

        Finished in 5.704 seconds
        870 tests, 2331 assertions, 4 failures

    These tests pass with the fix

commit 531b13893dc2c715e5cb988fdb872897547e6375
Author: Christopher D. Parks <christopher.daniel.parks@gmail.com>
Date:   Fri Apr 25 15:59:47 2014 -0700

    Fix for #640 - Allow default values for parameters to contain brackets

    Because JSDoc uses brackets to delimit default values inside the @param tag,
    default values containing brackets can get misparsed. We solve this by
    redefining splitName() in terms of splitNameMatchingBrackets() which tries
    to find the matching end bracket if the name starts with an open bracket.
    Ignores brackets inside strings. If splitNameMatchingBrackets() fails to find
    the closing bracket, we fall back to the original regex method.
2014-11-01 15:14:04 -07:00
Jeff Williams
2224bee3be do not try to normalize empty path strings
Fixes build breakage on non-Windows platforms.
2014-10-30 12:19:47 -07:00
Jeff Williams
fc2b4ad3d2 fix Windows path issues and static-file copying (#785)
- In the default template, look for the list of static file paths in the
config property `templates.default.staticFiles.include`. (You can still
use `paths` instead of `include`.)
- Handle path-normalization issues that prevented the default template
from copying user-specified static files on Windows.
- Normalize paths in `fs.toDir` so that callers get the correct path
separator on Windows.
2014-10-30 12:06:26 -07:00
Jeff Williams
d2e5dd888a fix gulpfile on Windows when the working directory contains spaces 2014-10-30 12:02:29 -07:00
Jeff Williams
a2e119a88b update ESLint dependency; enable new rules; delint 2014-10-27 12:58:32 -07:00
Jeff Williams
b28f3341a3 delint 2014-10-26 05:52:03 -07:00
Jeff Williams
e60fc3c717 prevent duplication when two parent classes have instance members with identical names (#613) 2014-10-25 11:05:56 -07:00
Jeff Williams
996c283733 handle symbol names with leading/trailing whitespace (#549) 2014-10-23 09:38:30 -07:00
Jeff Williams
58839223a9 strip module namespace from module and exports tag values (#786)
This change makes `/** @exports module:foo */` a synonym for `/** @exports foo */`.
2014-10-22 15:48:51 -07:00
Jeff Williams
5512af9677 update package schema, and add tests to validate package objects against the schema (#788) 2014-10-22 13:31:04 -07:00
Jeff Williams
53d2ed719b prevent cruft in Package objects (#787) 2014-10-22 12:22:22 -07:00
Jeff Williams
7471685fa9 show the inheritance chain for modules that export a single constructor (#594) 2014-10-22 09:41:11 -07:00
Jeff Williams
e5a3479beb fix an accidental method-signature change 2014-10-20 09:48:42 -07:00
Jeff Williams
ce79d0d5f2 bump revision 2014-10-20 09:35:46 -07:00