Skip to content

Commit 1f52753

Browse files
ShukantPalShukantPal
authored
Merge pull request #59 from webdoc-js/feature/flow-lang
Add support for flow types
2 parents aa30fc8 + 56f4356 commit 1f52753

File tree

4 files changed

+335
-50
lines changed

4 files changed

+335
-50
lines changed

‎azure-pipelines.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ steps:
2222
- checkout: ExampleDocs
2323
- task: NodeTool@0
2424
inputs:
25-
versionSpec: '10.x'
25+
versionSpec: '14.x'
2626
displayName: 'Install Node.js'
2727

2828
- script: |

‎example.api.json‎

Lines changed: 72 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
{
2+
"name": "",
23
"type": "RootDoc",
3-
"children": [
4+
"members": [
45
{
56
"name": "WebdocParser",
67
"type": "ClassDoc",
@@ -11,7 +12,7 @@
1112
"name": "STAGE_AST_LIKE",
1213
"type": "PropertyDoc",
1314
"brief": "",
14-
"description": "<p>The doctree-mod should run when the &quot;members&quot; are resolved to their actual AST parent. This\noccurs after {@code STAGE_BLANK}.</p>\n<p>Example:</p>\n<pre><code class=\"hljs language-js\"><span class=\"hljs-class\"><span class=\"hljs-keyword\">class</span> <span class=\"hljs-title\">DocumentedClass</span> </span>{\n <span class=\"hljs-keyword\">constructor</span>() {\n <span class=\"hljs-comment\">/** <span class=\"hljs-doctag\">@member <span class=\"hljs-type\">{string) *\\/\n this.instanceProperty = \"defaultValue\";\n /** @member {string}</span> </span>*\\/\n DocumentedClass.instanceCount = DocumentedClass.instanceCount\n ? DocumentedClass.instanceCount + 1 : 1;\n }\n}\n</span></code></pre>\n<p>Before STAGE_AST_LIKE, the symbols <code>instanceProperty</code> and <code>instanceCount</code> will be a child of\n<code>DocumentedClass#constructor</code>. However, in STAGE_ASK_LIKE, they will be resolved as children of\n<code>DocumentedClass</code>.</p>"
15+
"description": "<p>The doctree-mod should run when the &quot;members&quot; are resolved to their actual AST parent. This\noccurs after {@code STAGE_BLANK}.</p>\n<p>Example:</p>\n<pre><code class=\"hljs language-js\"><span class=\"hljs-class\"><span class=\"hljs-keyword\">class</span> <span class=\"hljs-title\">DocumentedClass</span> </span>{\n <span class=\"hljs-function\"><span class=\"hljs-title\">constructor</span>(<span class=\"hljs-params\"></span>)</span> {\n <span class=\"hljs-comment\">/** <span class=\"hljs-doctag\">@member <span class=\"hljs-type\">{string) *\\/\n this.instanceProperty = &quot;defaultValue&quot;;\n /** @member {string}</span> </span>*\\/\n DocumentedClass.instanceCount = DocumentedClass.instanceCount\n ? DocumentedClass.instanceCount + 1 : 1;\n }\n}\n</span></code></pre>\n<p>Before STAGE_AST_LIKE, the symbols <code>instanceProperty</code> and <code>instanceCount</code> will be a child of\n<code>DocumentedClass#constructor</code>. However, in STAGE_ASK_LIKE, they will be resolved as children of\n<code>DocumentedClass</code>.</p>"
1516
},
1617
{
1718
"name": "STAGE_BLANK",
@@ -101,7 +102,7 @@
101102
"type": "FunctionDoc",
102103
"brief": "",
103104
"description": "",
104-
"children": [
105+
"members": [
105106
{
106107
"name": "enter",
107108
"type": "MethodDoc",
@@ -148,6 +149,12 @@
148149
"brief": "",
149150
"description": ""
150151
},
152+
{
153+
"name": "condition",
154+
"type": "FunctionDoc",
155+
"brief": "",
156+
"description": ""
157+
},
151158
{
152159
"name": "createBlock",
153160
"type": "FunctionDoc",
@@ -245,7 +252,7 @@
245252
"description": ""
246253
},
247254
{
248-
"name": "extractType",
255+
"name": "extractTypeFailsafe",
249256
"type": "FunctionDoc",
250257
"brief": "",
251258
"description": ""
@@ -268,6 +275,12 @@
268275
"brief": "",
269276
"description": ""
270277
},
278+
{
279+
"name": "getIncludePattern",
280+
"type": "FunctionDoc",
281+
"brief": "",
282+
"description": ""
283+
},
271284
{
272285
"name": "initLogger",
273286
"type": "FunctionDoc",
@@ -352,20 +365,14 @@
352365
"brief": "",
353366
"description": ""
354367
},
355-
{
356-
"name": "morphTutorials",
357-
"type": "FunctionDoc",
358-
"brief": "",
359-
"description": ""
360-
},
361368
{
362369
"name": "packageApi",
363370
"type": "FunctionDoc",
364371
"brief": "<p>Resolves each package's top-level API docs.</p>",
365372
"description": ""
366373
},
367374
{
368-
"name": "packages",
375+
"name": "parse",
369376
"type": "FunctionDoc",
370377
"brief": "",
371378
"description": ""
@@ -382,6 +389,12 @@
382389
"brief": "",
383390
"description": ""
384391
},
392+
{
393+
"name": "parseCondition",
394+
"type": "FunctionDoc",
395+
"brief": "",
396+
"description": ""
397+
},
385398
{
386399
"name": "parseCopyright",
387400
"type": "FunctionDoc",
@@ -454,6 +467,12 @@
454467
"brief": "",
455468
"description": ""
456469
},
470+
{
471+
"name": "parseStepType",
472+
"type": "FunctionDoc",
473+
"brief": "",
474+
"description": ""
475+
},
457476
{
458477
"name": "parseTodo",
459478
"type": "FunctionDoc",
@@ -472,6 +491,12 @@
472491
"brief": "",
473492
"description": ""
474493
},
494+
{
495+
"name": "query",
496+
"type": "FunctionDoc",
497+
"brief": "",
498+
"description": "<p>Runs a query in the document tree and returns the matching document, according to the\nDocument Path Langugage expression {@code query}.</p>"
499+
},
475500
{
476501
"name": "queueTargets",
477502
"type": "FunctionDoc",
@@ -513,7 +538,7 @@
513538
"type": "FunctionDoc",
514539
"brief": "",
515540
"description": "",
516-
"children": [
541+
"members": [
517542
{
518543
"name": "installPlugin",
519544
"type": "MethodDoc",
@@ -529,12 +554,24 @@
529554
"brief": "",
530555
"description": ""
531556
},
557+
{
558+
"name": "resolveConfigurator",
559+
"type": "FunctionDoc",
560+
"brief": "",
561+
"description": ""
562+
},
532563
{
533564
"name": "resolvedThis",
534565
"type": "FunctionDoc",
535566
"brief": "",
536567
"description": ""
537568
},
569+
{
570+
"name": "resolveFlowDataType",
571+
"type": "FunctionDoc",
572+
"brief": "",
573+
"description": ""
574+
},
538575
{
539576
"name": "resolveLinkArray",
540577
"type": "FunctionDoc",
@@ -565,6 +602,12 @@
565602
"brief": "",
566603
"description": ""
567604
},
605+
{
606+
"name": "restoreDoc",
607+
"type": "FunctionDoc",
608+
"brief": "",
609+
"description": ""
610+
},
568611
{
569612
"name": "searchExtendedClasses",
570613
"type": "FunctionDoc",
@@ -578,29 +621,41 @@
578621
"description": ""
579622
},
580623
{
581-
"name": "symbolToDoc",
624+
"name": "sources",
582625
"type": "FunctionDoc",
583626
"brief": "",
584627
"description": ""
585628
},
586629
{
587-
"name": "transformRecursive",
630+
"name": "stepInstanceMember",
588631
"type": "FunctionDoc",
589632
"brief": "",
590633
"description": ""
591634
},
592635
{
593-
"name": "traverse",
636+
"name": "stepRMember",
594637
"type": "FunctionDoc",
595-
"brief": "<p>Preorder traversal of all the docs</p>",
638+
"brief": "",
596639
"description": ""
597640
},
598641
{
599-
"name": "tutorialDoc",
642+
"name": "symbolToDoc",
600643
"type": "FunctionDoc",
601644
"brief": "",
602645
"description": ""
603646
},
647+
{
648+
"name": "transformRecursive",
649+
"type": "FunctionDoc",
650+
"brief": "",
651+
"description": ""
652+
},
653+
{
654+
"name": "traverse",
655+
"type": "FunctionDoc",
656+
"brief": "<p>Preorder traversal of all the docs</p>",
657+
"description": ""
658+
},
604659
{
605660
"name": "updateScope",
606661
"type": "FunctionDoc",

0 commit comments

Comments
 (0)