archive-gh-me/documentation
1
0
Fork 0
mirror of https://github.com/documentationjs/documentation.git synced 2026-01-25 14:26:29 +00:00
Code Issues Projects Releases Wiki Activity
486 Commits 17 Branches 116 Tags
Commit Graph

142 Commits

Author SHA1 Message Date
Tom MacWright
b3ac22430b Test and document behavior around documenting destructured params. 2015-12-06 19:47:36 -05:00
Tom MacWright
1d1aba82ab Improve parameter inference for destructuring and defaults 
Fixes #271
 2015-12-06 19:29:04 -05:00
John Firebaugh
1a711644f5 Fix test 2015-12-06 10:56:08 -08:00
Tom MacWright
d069b6a40b Support new node versions, including v4 and v5 
* Compare strings as lowercase, to permit for v4+ compatibility
* Fix bad reference to loc.name
* Update README badge and fixture
* Remove brfs dependency
* Remove traverse
* Remove browser transform support
 2015-12-01 15:34:50 -05:00
Tom MacWright
d470b54213 Correctly interpret name tag. Fixes #205 2015-11-28 11:50:29 -05:00
Iilei
ebcee3ae07 Pass though hljs options: Enable hljs highlightAuto and languages 
By providing a hljs object within the configuration, `@example` tags in
a variety of languages are parsed properly.
 2015-11-25 17:31:58 +01:00
Tom MacWright
cd0e8143db Simplify extension check, add coverage 2015-11-24 13:00:32 -05:00
Tom MacWright
4208293565 Fix test fixture 2015-11-24 11:41:42 -05:00
Tom MacWright
fe82dde727 Fix HTML validity with default template 2015-11-24 11:35:17 -05:00
Tom MacWright
50aaf9d35b --watch and --serve flags 
These new flags replace the functionality of
dev-documentation
 2015-11-24 11:21:11 -05:00
John Firebaugh
4416acb99f Fix tests (fixes #254) 2015-11-22 12:08:02 -08:00
Tom MacWright
e4cb2ffe67 Force eslint bump, confirm its included bugfix. Fixes #204 2015-11-17 11:21:48 -05:00
Tom MacWright
432151bce8 Fix nullable type support. Fixes #245 2015-11-17 11:12:42 -05:00
Tom MacWright
33552c6e8a Fix type merging. Fixes #233 
Some params cannot be identified with only param.name. This
changes the algorithm to transform parameters into doc objects
first, and then using the value of doc.name, which is defined
even for parameters with default values.
 2015-11-09 12:51:15 -05:00
Tom MacWright
eed48f7840 Support github links in markdown output 2015-11-09 12:04:52 -05:00
Tom MacWright
8a2ec3efad Allow param tag type to be inferred and merged with description 2015-11-05 14:48:41 -05:00
Tom MacWright
012a16f246 Fix name-annotated rest annotations 2015-11-04 17:56:59 -05:00
Tom MacWright
70cc7d0718 Infer Flow type aliases into typedefs. Fixes #227 
Given the `type` tag introduced with Flow, this can infer
a typedef statement, as well as infer its potentially
nested properties and their types.

This also includes

* Refactor of Markdown AST generation that fixes #228
* Refactor of nest.js to handle multi-level nesting
 2015-11-04 11:25:32 -05:00
Tom MacWright
55f79ebf14 Infer rest parameters. Fixes #223 2015-11-03 17:40:33 -05:00
Tom MacWright
c53f577240 Avoid filtering comments in lint mode. Fixes #186 2015-11-03 12:35:39 -05:00
Tom MacWright
b53f94766e Nest both properties and params. Fixes #164 2015-11-03 11:59:17 -05:00
Tom MacWright
51d4478ac2 Refactor Markdown AST representation. Fixes #216 2015-11-03 10:50:18 -05:00
Tom MacWright
ac5b04183f Improve internal documentation, upgrade theme-default. Refs #115 2015-10-30 15:44:46 -04:00
Tom MacWright
7ee83b655f Fix default formatting 2015-10-30 13:44:03 -04:00
Tom MacWright
8886ac6157 Switch from babylon to babel-core. Fixes #201 2015-10-30 12:37:56 -04:00
Tom MacWright
63c0ca633f Fix type applications creating accidental elements in Markdown 2015-10-28 17:12:54 -04:00
Tom MacWright
eb1089e594 Stop inferring parameters if fn is within a call. 
Fixes #191

This a specific exception for the case identified in 191: we could,
instead, include only cases of clear proximity, like var foo = function,
or function foo.
 2015-10-27 17:52:28 -04:00
Tom MacWright
8ca0e0844f Support ES7 class properties 2015-10-27 11:55:55 -04:00
Tom MacWright
1eee5a8f93 Infer class kind from es6 class 2015-10-27 11:15:12 -04:00
Tom MacWright
844f4b73bb Use vfile-reporter to format error output 2015-10-25 20:39:28 -04:00
Tom MacWright
cefe68908b Infer destructured params. Fixes #170 
Waiting on an answer in https://github.com/babel/babel/issues/2543
because tests will currently fail.
 2015-10-18 18:52:17 -04:00
Tom MacWright
b95b5877cd Modernize eslint configuration, customize eslint for tests 
Fixes #179
 2015-10-15 16:55:54 -04:00
John Firebaugh
ae13664021 Nested hierarchy support 2015-10-13 17:36:37 -07:00
John Firebaugh
9dcf926669 Events are not a special scope 2015-10-13 16:37:19 -07:00
John Firebaugh
39efefb2b7 Update to doctrine-0.7.0 2015-10-12 20:28:16 -07:00
John Firebaugh
efd5b4ccb4 Correctly name comments attached to module.exports (fixes #178) 2015-10-12 15:57:56 -07:00
John Firebaugh
5449757782 More test cases and fixes for exports inference 2015-10-12 14:06:14 -07:00
John Firebaugh
7327e0093c Make hierarchy tests 100% self-covering; fix bugs 2015-10-11 14:20:14 -07:00
Tom MacWright
d7f06fa5c4 Store commentLineNumber on errors. Fixes #159 
cc @jfirebaugh for the review
 2015-10-06 16:23:22 -04:00
Tom MacWright
a65801a6d4 Add and test default parameter parsing. 
cc @killercup this implements default parameter parsing for both
flow-annotated and unannotated methods
 2015-10-06 15:51:46 -04:00
Tom MacWright
11826ad98c Add return type inference as well 2015-10-06 10:44:08 -04:00
Tom MacWright
7730af7603 Implement flow type inference 
cc @thejameskyle

`lib/flow_doctrine.js` is where we convert Babel-parsed
Flow annotations into doctrine-style objects so they
can be formatted with all of the existing helpers.
 2015-10-06 10:31:54 -04:00
Tom MacWright
b173cf14a5 Fix parameter sorting, nest properties in Markdown 2015-10-05 15:02:33 -04:00
Tom MacWright
cbff1d3396 Cover es6 imports as well as exports 2015-10-05 14:26:44 -04:00
Tom MacWright
c38b91b4e3 Reparse transformed source 2015-10-05 14:19:48 -04:00
Tom MacWright
1e9e1dbe35 Update infer example 2015-10-04 22:01:18 -04:00
Tom MacWright
7b156d8769 Babel! 🙌 
cc @jfirebaugh for the review

This was easier than expected.
 2015-10-04 21:55:54 -04:00
Tom MacWright
5753da1af6 Just deal with comment.params, not comment.tags 2015-10-04 14:04:12 -04:00
Tom MacWright
30525847f3 Handle both flattened and unflattened forms 2015-10-04 13:27:15 -04:00
Tom MacWright
7ff858420e Infer parameters 
This uses the AST to add (untyped) params where they aren't explicitly
specified.

Would love to infer types here as well, but espree doesn't support
them yet.

cc @anandthakker / @jfirebaugh for the review
 2015-10-04 12:51:41 -04:00