1198 Commits

Author SHA1 Message Date
Tom MacWright
cb8fdfa74f feat(bin): Support globs on windows and use smarter recursion (#629)
This brings logic from eslint over to documentation: instead of readdirSync, we're using the glob
module. This also, I hope, will let us support globs on Windows without changing OSX/Linux behavior.
Fixes #607
2016-12-26 10:24:30 -05:00
Tom MacWright
7a66b3f5bb perf(dependencies): Move standard-changelog to devDependencies (#636)
Saves install time and space.

Refs https://github.com/documentationjs/documentation/issues/622
2016-12-23 12:54:38 -05:00
Tom MacWright
44aab3fe44 beta.17 v4.0.0-beta.17 2016-12-23 12:10:18 -05:00
Antonio Quinonez
87bfe7e8b7 doc(readme): Fix learning documentation 2016-12-23 12:04:01 -05:00
Antonio Quinonez
aea22d4d5a docs(readme): minor style, spelling, and punctuation fixes 2016-12-22 14:03:33 -05:00
Tom MacWright
a4eddba384 chore(globals-docs): Update globals-docs to support linking TypedArray
Fixes https://github.com/documentationjs/globals-docs/pull/3
2016-12-13 15:50:39 -08:00
Friedel Ziegelmayer
f1e0267e7c fix(hierarchy): collect events from static and instance members (#628)
Fixes #486
2016-12-08 11:59:26 -05:00
Tom MacWright
73ba79b37a Changelog and package for beta16 v4.0.0-beta16 2016-12-07 17:38:36 -05:00
Tom MacWright
ab16a20872 fix(bin): Remove dead code in documentation.js command (#627) 2016-12-07 17:29:06 -05:00
Denis Andrejew
11fef7d858 docs(install): reiterate installation directions in getting started
crucial since home page links to GETTING_STARTED.md, without first showing any installation instructions -- those are currently only found in the README.md / GH repo landing page.
2016-12-06 22:08:46 -05:00
Friedel Ziegelmayer
89fb67f907 feat(build): load passed in config option (#625)
* feat(build): load passed in config option

Fixes #https://github.com/documentationjs/gulp-documentation/issues/27

* refactor(build): streamline loadConfig path
2016-12-05 15:00:10 -05:00
Erik Arvidsson
363a108fe4 fix(extractors): Document export default value (#623)
With `--document-exported` we used to only support

```js
export default Declaration
```

and

```js
export default IdentifierExpression
```

With this change we generate a comment for all default exports.

Fixes #543
2016-12-03 09:30:24 -08:00
Tom MacWright
381ef48b9f docs(readme): Add new usage examples to README
https://github.com/documentationjs/documentation/pull/588
2016-12-01 14:12:06 -05:00
Tom MacWright
5c3b6baa7a docs(cli): Improve selection of examples that the CLI tool lists 2016-12-01 14:09:41 -05:00
Tom MacWright
846ab94772 fix(parser): Avoid error about deoptimization on very large files (#621)
This sets compact: false for babelify, so that Babel doesn't complain about not being able to

compact'ify very large files

* https://github.com/documentationjs/gulp-documentation/issues/14
2016-11-26 18:57:09 -05:00
Tom MacWright
8b04029138 feat(output): Display type information for typedefs in Markdown and HTML
This is a follow-up commit because I didn't format the original commit message properly and didn't

want to ammend master.
2016-11-25 18:35:25 -05:00
Tom MacWright
f9ddb9cd29 Output typedef content in Markdown and HTML. Fixes #359 (#619) 2016-11-25 18:31:21 -05:00
Tom MacWright
6998a05939 chore(dependencies): Update dependency ranges for all that can be seamlessly upgraded (#617)
We're pinning certain dependencies, still, like parse-filepath, because they alter

documentation.js's behavior: those will need further investigation
2016-11-23 16:47:38 -05:00
Tom MacWright
5783156033 Document deployment process, update changelog for beta15 v4.0.0-beta15 2016-11-23 14:50:27 -05:00
Tom MacWright
5a67282e57 Nail down bugfix. Fixes #556 2016-11-23 13:59:56 -05:00
Tom MacWright
a1eb45d21e Infer class augments tag with MemberExpression superClass. Fixes #458 (#616) 2016-11-23 13:52:52 -05:00
Friedel Ziegelmayer
d96aa47673 feat(config): add file property for notes (#614)
* feat(config): add file property for notes

Fixes #609

* feat(config): resolve files against the config file location
2016-11-23 08:31:10 -05:00
Tom MacWright
43e01ce076 Update changelog and package.json for beta14 v4.0.0-beta14 2016-11-21 17:52:59 -05:00
Tom MacWright
7f400da151 Highlight all Markdown, not just examples. Fixes #610 (#613)
* Highlight all Markdown, not just examples. Fixes #610

* Fix html output fixture

* Remove unrelated change
2016-11-21 17:47:00 -05:00
Friedel Ziegelmayer
70c081fbe9 fix(config): only strip comments on json files (#611)
* fix(config): only strip comments on json files

Fixes #608

* refactor(config): use path.extname instead of custom logic
2016-11-21 13:27:05 -05:00
Tom MacWright
98beb6dbd8 Check length before assigning to a return tag (#606) 2016-11-18 20:20:46 -05:00
Tom MacWright
29cd58bb31 Merge inferred return type like we do for params. Refs #359 (#604) 2016-11-18 11:59:15 -05:00
Tom MacWright
4dc8cb0ca9 Support system.import with nice handy babel plugin (#603)
* Support system.import with nice handy babel plugin

* Use a smaller import

* Use smaller imports here too
2016-11-18 10:51:03 -05:00
Tom MacWright
7d4014821d Add regression case for #498 (#602) 2016-11-18 10:16:53 -05:00
Tom MacWright
2ac4d04a8d Format optional types with ? instead of [] (#538)
* Format optional types with ? instead of []

Fixes #509

* ? as postfix not prefix

* Update test fixtures
2016-11-18 09:48:25 -05:00
Tom MacWright
1c48a4f80d Fix membership assignment for old-fashioned prototype members (#599)
Fixes #598

This _changes behavior_: previously in the case of

```js
/** base */
var Foo = function Bar() {
  {
    /** */
    this.baz = 0;
  }
};
```

We assigned baz to Bar. Now we will assign Baz to Foo. I believe this is
right, since in JavaScript Bar is not actually bound in this code.
2016-11-16 11:32:59 -05:00
Tom MacWright
fc58bebaef Document new inferPrivate and extension options 2016-11-11 11:31:52 -05:00
Tom MacWright
f926b3da23 Add lint example 2016-11-11 11:24:05 -05:00
Tom MacWright
375e8007b2 Update Node API to include only exposed API surface 2016-11-11 11:22:07 -05:00
Tom MacWright
393002d5c1 Add too-much-inference troubleshooting topic 2016-11-11 11:04:28 -05:00
Tom MacWright
bbe5578435 Update changelog and package for beta13 v4.0.0-beta13 2016-11-10 15:27:38 -05:00
Tom MacWright
ab62619af8 Fix linker stack null reference (#590) 2016-11-10 15:26:27 -05:00
Tom MacWright
ed9d2b73d3 Warn about npm v2. Fixes #583 2016-11-09 16:10:39 -05:00
Tom MacWright
ade0bc1d32 Update package and changelog [skip ci] v4.0.0-beta12 2016-11-04 17:03:56 -04:00
Tom MacWright
9a6549cd79 Fix lint and unittest issues (#584) 2016-11-04 17:01:43 -04:00
Matthew Vlietstra
78ac0b093b * Fixed windows serve, see #336. (#581) 2016-10-31 20:52:33 -07:00
Chad McElligott
7c7d56c3bf Fix ReferenceError in default theme (#576)
Closes #559.
2016-10-26 11:08:30 -04:00
Erik Arvidsson
0fa38736cd Update Doctrine
Update Doctrine to 1.5 to pick up BooleanLiteralType.

Make sure we can output html/md for BooleanLiteralType.

Towards #512
2016-10-24 12:23:48 -04:00
Erik Arvidsson
efa76ef7b5 Pick up comments on VariableDeclarations (#571)
When we find the binding for an export we get the VariableDeclarator.
It is common for people to write their JSDoc comment on the parent
VariableDeclaration so we check that in case there is no comment on the
declarator.

Fixes #570
2016-10-21 13:08:36 -07:00
Patrick Gotthardt
9e6bcefacc Resolve imports without extension (#569)
For `--document-exported` we now use Node.js's `require.resolve`
method to resolve the path for modules referenced by other modules.

This fixes issues where we failed to load imported modules which lead to
a null comment being attached which caused an exception.
2016-10-16 11:10:05 -07:00
Michaël Zasso
9c0adba916 Show GitHub link for nested elements in default theme (#562) 2016-10-12 08:10:39 -07:00
Tom MacWright
7ccf89d83c Fix linkerStack resolution order (#564) 2016-10-11 18:08:13 -04:00
Tom MacWright
145c199a68 Update package for beta11 v4.0.0-beta11 2016-10-10 20:10:23 -04:00
Tom MacWright
324e0b9c53 Update changelog for beta11 2016-10-10 20:10:07 -04:00
Erik Arvidsson
384ccbcf5e Fix inferring return type of var function (#545)
I accidentally broke the detection of the return type in:

```js
var f = function(x: number): boolean {}
```
2016-10-10 17:18:07 -04:00