31 Commits

Author SHA1 Message Date
Hugo Josefson
7e0127819a Fix args regression: readme --shallow --format (Invalid second argument) (#968)
* Add shared_options to readme command.

This makes --shallow and --format work again.

* Update yarn.lock based on package.json.

* Move readme example to where it works,

remove superfluous usage string.

yargs@>=7 throws exceptions on incorrectly structured builder objects.

* Update expected readme test fixture.

* Update bin-readme snapshot.

* s/_.assign/Object.assign/g thanks to node@>=4.

* Update yarn.lock based on package.json (lint-staged@6)

* Override flow error message.
2017-12-10 15:04:32 +03:00
Tom MacWright
e4781ebf54 fix: Fix the split in HTML at 33/67% instead of calculating percentages (#939)
Previously this was calculated so that the left page would expand to its natural size. That's not
really what we want, because the natural size could be as high as 100%.

Fixes #927
2017-10-12 16:26:22 -07:00
Michel Simonot
7a548eb444 fix(html): Display all levels of parameter properties. (#933)
Fix default_theme to render all parameter properties.
 
- Split the parameter property template portion into its own partial.
- Have the new partial recursively call itself if there are sub-properties.
2017-10-04 12:34:39 -07:00
Anton
e203df51c0 chore: Replace babel-preset-es2015 on babel-preset-env Fixed #931 (#932) 2017-10-03 17:27:58 -07:00
Anton Shchekota
227db1c9ee chore: updated yargs Fixed #836 2017-09-29 18:50:38 +03:00
Anton Shchekota
f375b2ba75 chore: updated flow js 2017-09-29 16:17:19 +03:00
Tom MacWright
de19175980 test: Add tests for moduleFilters, tiny typo fix 2017-09-14 17:04:34 -07:00
Martin Broder
7fc6ca8f73 fix: special property names in flowtypes 2017-09-14 15:57:13 -07:00
Tom MacWright
b97241f8d1 fix: Enable dynamicImport plugin to support import() syntax (#903)
Fixes #902
2017-09-07 09:51:24 -07:00
Ryan Hendrickson
125a577199 fix: regression in toc causing crash 2017-09-04 19:25:40 -04:00
Ryan Hendrickson
5bdbf1f870 fix: cover more hideconstructor cases 2017-09-04 16:37:30 -04:00
Ryan Hendrickson
a04b6fd61d fix: @name tag disconnects comment (#897)
The previous support for @name tags suppressing inference from
surrounding code was ad-hoc and incomplete. This commit makes a @name
tag (or a tag acting as a @kind/@name shorthand combo, like @function)
detach the `ast` field from the comment context, so that the surrounding
code will be universally ignored per the JSDoc spec.
2017-09-03 23:44:55 -07:00
Ryan Hendrickson
c94412a7aa feat: groups in toc (#895) 2017-09-03 23:44:31 -07:00
Ryan Hendrickson
7a07d5118d feat: implement @hideconstructor (#898)
Per usejsdoc.org, this tag goes either in a comment attached to a
function that has declared that function to be a class, or in a comment
on an ES6 class constructor.
2017-09-03 23:07:13 -07:00
Mitermayer Reis
2df7d3e54b style: Making return type params consistent with the rest of the code base (#894) 2017-09-02 10:20:47 -07:00
Tom MacWright
e0b605f817 style: Avoid optional parameter syntax
Supporting this syntax uncorks a whole bottle of worms and requires participation in more of the
JavaScript ecosystem and is not worthwhile in my opinion at this time.

Fixes #873
2017-08-12 14:25:34 -07:00
Anton
0324865ad5 fix: make html and markdown second option optional (#871)
Fixed #869
2017-08-09 10:25:32 -07:00
Andrew Hutchings
23aa981c30 feat: convert Flow's ThisTypeAnnotation to a doctrine NameExpression (#870) 2017-08-09 09:21:54 -07:00
Anton
e73dd982a7 chore: Updated Flow.js dependency on 0.52.0 (#862) 2017-08-08 14:28:19 -07:00
Anton
aa3496af90 fix: alphabetical sort and add flow notation to sort file (#861)
* Removed sort by memberof, when the memberOf is the same of items then sort function doesn't works correctly.

Added Unit Tests
Fixed #838

* Flow.js : added flow notation for sort.js
2017-08-08 14:27:10 -07:00
Anton
ecf16bdaa0 fix: cli options should override package.json options
The first priority from CLI(from user) settings then package.json.

Fixed #845
2017-08-04 11:29:05 -07:00
Tom MacWright
dccb15160d fix(theme): Remove dead stepsibling navigation code 2017-07-31 14:59:24 -04:00
David Halls
6509ae813e feat(theme): Flexible sidebar for default theme 2017-07-31 13:31:01 -04:00
Tom MacWright
5b373ff2fe revert(polyglot): Remove polyglot mode
BREAKING CHANGE: I'd like to still support C++ and other languages in the future! But I'm much
happier doing so by separating the extraction & input phases to the degree that documentation.js can
read the output of another module that extracts JSDoc comments from C++ code, rather than having CPP
support in it.

Fixes #850. Fixes #731. Fixes #702. Fixes #132.
2017-07-27 13:58:49 -04:00
Anton
ea69608e92 fix: Report nesting errors instead of throwing them as errors
Check on parent element: foo.bar sub-parametr should be documeted with parent.
Fixed #832 issue
2017-07-07 15:37:26 -04:00
Anton
15239d1943 chore: Updated eslint. fixed no-useless-escape rule. (#834) 2017-07-05 10:01:26 -04:00
David Halls
473f317c78 fix: Fix filtering in the default theme 2017-06-23 15:42:48 -04:00
David Halls
61968c790f fix: Show () for callbacks
* Show callback signatures

* Add output test for callback

* Reformat is_function

* Fix comparator

* Use camelCase #818
2017-06-23 15:41:21 -04:00
David Halls
5fb77bcf48 fix(html output): Fix links between navigation and items in HTML documentation 2017-06-06 09:38:27 -04:00
Tom MacWright
290fc09b91 test: Improve coverage of infer/kind, remove unused filterAccess line (#776) 2017-05-11 10:33:45 -04:00
Tom MacWright
11d9045a00 Native Flow, use Jest (#767)
* build: Use Flow syntax without comments.

We're switching to Flow annotations - not Flow comments. This
gives documentation.js the ability to self-document without
JSDoc types and improves our compatibility with tools like
prettier.

Fixes #729. Fixes #709
2017-05-08 20:46:21 -04:00