Tom MacWright
937ac48154
Forgiving links to 404s
v4.0.0-beta7
2016-07-06 12:43:36 -04:00
Tom MacWright
a598641f7c
beta6
v4.0.0-beta6
2016-07-06 12:27:16 -04:00
Waldir Pimenta
7f2aa31fbd
Add license title ( #468 )
...
It's not strictly required, but it's useful metadata, and part of the recommended license template text (see http://choosealicense.com/licenses/isc/ and https://opensource.org/licenses/isc-license )
2016-07-01 23:06:01 -04:00
Tom MacWright
6cbf4bd1d8
Improve internal documentation, add examples
2016-06-17 16:29:57 -04:00
Tom MacWright
8287ab0539
Fix names of methods for generated documentation
2016-06-17 16:18:07 -04:00
Tom MacWright
7696e965ca
Reorganize server code into lib/serve
2016-06-17 16:07:49 -04:00
Tom MacWright
6bf515e936
Add FAQ entry to lock down understanding around #413
2016-06-17 15:57:46 -04:00
Tom MacWright
c33fe6b904
Add usage doc for node usage
2016-06-12 17:14:46 -04:00
Oscar Dub
c04ea4f818
Fix ToC filter in default theme. ( #457 )
...
* Fix filter functionality.
* Add missing semicolon.
* Update tests.
* Replace whitespace to appease tests.
* Tweak whitespace.
* Tweak whitespace.
2016-06-12 17:08:51 -04:00
Tom MacWright
891b06c8f9
Merge pull request #447 from documentationjs/local-util
...
Move documentation-theme-utils into core
2016-06-09 10:46:04 -04:00
Tom MacWright
3f08c19533
Move documentation-theme-utils into core
...
Also:
* Fixes many issues in the default theme
* Moves the default theme from default-theme to default_theme
* Creates a new, robust linker infrastructure that will support
bare links
* Replaces slugg with github-slugger
* Outputs unknown types as Any. Fixes #451
2016-06-08 12:40:05 -04:00
Tom MacWright
9bda56842f
Merge pull request #453 from arv/class-property
...
Infer class properties
2016-06-07 20:49:09 -04:00
Tom MacWright
305a3aa6ae
Merge pull request #452 from arv/nullable
...
Treat flow nullable types as nullable
2016-06-07 20:47:13 -04:00
Erik Arvidsson
e13e5d7db3
Infer class properties
...
Flow/TypeScript has a special syntax for class properties. These
should be grouped under the class that they belong to.
2016-06-07 17:20:55 -07:00
Erik Arvidsson
8c14481260
Treat flow nullable types as nullable
...
Previously they were treated as optional params which is not the
same thing.
2016-06-07 15:10:39 -07:00
Tom MacWright
74445b60e6
Merge pull request #450 from monkbroc/patch-1
...
No context for narrative sections
2016-06-06 17:01:45 -04:00
Julien Vanier
6ae89c675d
No context for narrative sections
...
When using `--config configuration.yml` with narrative sections, `documentation build` crashes with `TypeError: Cannot read property 'github' of undefined` (regardless if `--github` is passed or not). Verify that the `comment.context` object exists before reading its properties.
2016-06-06 16:45:57 -04:00
Tom MacWright
8a5c1b88dd
Merge pull request #448 from oizulain/patch-1
...
Fix example links in README
2016-06-06 11:59:05 -04:00
Oier Izulain
f0e55e1495
Fix example links in README
2016-06-06 15:08:35 +02:00
Tom MacWright
ff37f2b736
Merge pull request #445 from documentationjs/json-require
...
Requiring JSON files is broken
2016-06-03 14:01:39 -04:00
Tom MacWright
367078e34d
Fix and combine extension testcase
2016-06-03 13:56:34 -04:00
Tom MacWright
30261d3627
Merge branch 'stevoland-extension-fail' into json-require
2016-06-03 13:49:15 -04:00
Tom MacWright
caa1637880
Fix ability to require() JSON and other files without extension.
...
Fixes #402
2016-06-03 13:47:42 -04:00
Tom MacWright
dead5bb9f7
Finish internal documentation
2016-06-02 15:00:12 -04:00
Tom MacWright
aadb8addc6
Even more documentation
2016-06-02 14:53:58 -04:00
Tom MacWright
09a4faa672
Cover lib/parse
2016-06-02 14:32:04 -04:00
Tom MacWright
02df59c9a3
Try to make flatteners private
2016-06-02 13:39:06 -04:00
Tom MacWright
04355a8b91
More internal documentation
2016-06-02 13:35:27 -04:00
Tom MacWright
21371e71da
Inline method
2016-06-02 13:28:57 -04:00
Tom MacWright
7f032d6c6a
Improve internal documentation
2016-06-02 13:22:06 -04:00
Tom MacWright
e25919b0d4
Improve internal documentation
2016-06-02 12:40:06 -04:00
Tom MacWright
69a0fdcb80
Merge pull request #444 from kripod/patch-2
...
Fixed GitHub link generation on Windows (resolves #318 )
2016-06-02 12:27:23 -04:00
Kristóf Poduszló
81ff705d6c
Fixed GitHub link generation on Windows ( resolves #318 )
2016-06-02 11:46:06 +02:00
Tom MacWright
9f63b61591
Start with documentation schema validation. Refs #398
2016-06-01 20:50:42 -04:00
Tom MacWright
29baa47cd8
To beta5
v4.0.0-beta5
2016-06-01 19:21:15 -04:00
Tom MacWright
bf0f100368
Merge pull request #441 from arv/infer-private
...
Add support for inferring private based on the name
2016-06-01 19:08:49 -04:00
Tom MacWright
e67409e296
More docs
2016-06-01 17:41:02 -04:00
Erik Arvidsson
629ea6f3a8
Add support for inferring private based on the name
...
This adds a command line flag called `--infer-private` which is a
string (defaults to `^_`) which is used as a regexp for inferring
if a name is private or not.
For example:
```js
/** C */
class C {
/** I'm public */
m() {}
/** I'm private */
_p() {}
}
```
Fixes #436
2016-06-01 14:40:08 -07:00
Tom MacWright
d1e5baf578
more documentation improvements
2016-06-01 17:30:33 -04:00
Tom MacWright
7dad60bff2
Document parsePackedRefs
2016-06-01 17:21:33 -04:00
Tom MacWright
1570955520
Improve internal documentation
2016-06-01 17:17:03 -04:00
Tom MacWright
661f5ceac9
Test corrected export naming. Fixes #387
2016-05-27 17:46:26 -04:00
Tom MacWright
0f6ee797bc
Merge pull request #438 from zacharygolba/decorator-support
...
feat: add decorator support
2016-05-27 17:36:35 -04:00
Tom MacWright
7e783b978d
beta4
v4.0.0-beta4
2016-05-27 11:31:59 -04:00
Tom MacWright
b9640a6b99
Remove old, bad default-theme package. Add explicit lodash requirement
2016-05-27 11:31:26 -04:00
Tom MacWright
432259d9ea
Documentation documentation. Fixes #45
2016-05-27 11:17:55 -04:00
Zachary Golba
f1e35ad763
feat: add decorator support
2016-05-26 20:34:37 -04:00
Tom MacWright
3f82c709f9
To beta3
v4.0.0-beta3
2016-05-26 14:21:58 -04:00
Tom MacWright
11f13df60f
Add troubleshooting. Fixes #428 . Fixes #401
2016-05-26 14:08:12 -04:00
Tom MacWright
0727ef8f55
Document sorting/configuration system. Fixes #100 . Fixes #14
2016-05-26 14:03:31 -04:00