Explorar el Código

Update Options handlbar scheme (#2397)

Guy Carmeli hace 7 años
padre
commit
fb1f68a6bb
No account linked to committer's email address

+ 1
- 2
docs/docs/options/BottomTabs.md Ver fichero

1
-<a name="BottomTabs"></a>
1
+<h1>BottomTabs</h1>
2
 
2
 
3
-## BottomTabs
4
 **Properties**
3
 **Properties**
5
 
4
 
6
 | Name | Type |
5
 | Name | Type |

+ 1
- 2
docs/docs/options/Button.md Ver fichero

1
-<a name="Button"></a>
1
+<h1>Button</h1>
2
 
2
 
3
-## Button
4
 **Properties**
3
 **Properties**
5
 
4
 
6
 | Name | Type |
5
 | Name | Type |

+ 1
- 2
docs/docs/options/NavigationOptions.md Ver fichero

1
-<a name="NavigationOptions"></a>
1
+<h1>NavigationOptions</h1>
2
 
2
 
3
-## NavigationOptions
4
 **Properties**
3
 **Properties**
5
 
4
 
6
 | Name | Type |
5
 | Name | Type |

+ 1
- 2
docs/docs/options/TopBar.md Ver fichero

1
-<a name="TopBar"></a>
1
+<h1>TopBar</h1>
2
 
2
 
3
-## TopBar
4
 **Properties**
3
 **Properties**
5
 
4
 
6
 | Name | Type |
5
 | Name | Type |

+ 3
- 0
docs/templates/header.hbs Ver fichero

1
+<h1>{{anchorName}}</h1>
2
+
3
+{{>sig-name}}

+ 14
- 0
docs/templates/sig-name.hbs Ver fichero

1
+{{#if virtual}}*{{/if}}{{#with (parentObject)}}{{#if virtual}}*{{/if~}}{{/with~}}
2
+{{#if name}}{{#sig~}}
3
+{{{@depOpen}~}}
4
+{{{@codeOpen}~}}
5
+{{#if @prefix}}{{@prefix}} {{/if~}}
6
+{{@parent~}}
7
+{{#if @methodSign}}{{#if (isEvent)}} {{@methodSign}}{{else}}{{@methodSign}}{{/if}}{{/if~}}
8
+{{{@codeClose}~}}
9
+{{#if @returnSymbol}} {{@returnSymbol}}{{/if~}}
10
+{{#if @returnTypes}} {{>linked-type-list types=@returnTypes delimiter=" \| " }}{{/if~}}
11
+{{#if @suffix}} {{@suffix}}{{/if~}}
12
+{{{@depClose}~}}
13
+{{~/sig}}{{/if~}}
14
+{{#if virtual}}*{{/if}}{{#with (parentObject)}}{{#if virtual}}*{{/if~}}{{/with~}}

+ 16
- 14
scripts/generate-js-doc.js Ver fichero

2
 const fs = require('fs');
2
 const fs = require('fs');
3
 const path = require('path');
3
 const path = require('path');
4
 
4
 
5
-const paramsDir = './lib/src/params/';
6
-const optionsDir = './lib/src/params/options/';
5
+const PARAMS_DIR = './lib/src/params/';
6
+const OPTIONS_DIR = './lib/src/params/options/';
7
 const OUTPUT_DIR = './docs/docs/';
7
 const OUTPUT_DIR = './docs/docs/';
8
-const partial = ['./docs/templates/scope.hbs', './docs/templates/docs.hbs'];
8
+const OPTION_PARTIALS = ['./docs/templates/header.hbs', './docs/templates/sig-name.hbs'];
9
+const PARTIALS = ['./docs/templates/scope.hbs', './docs/templates/docs.hbs'];
9
 
10
 
10
-const generateMarkdownForFile = ({ file, outputDir }) => {
11
+const generateMarkdownForFile = ({ file, outputDir, partial }) => {
11
   const templateData = jsdoc2md.getTemplateDataSync({ files: file });
12
   const templateData = jsdoc2md.getTemplateDataSync({ files: file });
12
   const classNames = getClassesInFile(templateData);
13
   const classNames = getClassesInFile(templateData);
13
-  classNames.forEach((className) => createDocFileForClass(className, templateData, outputDir));
14
+  classNames.forEach((className) => createDocFileForClass({ className, templateData, outputDir, partial }));
14
 };
15
 };
15
 
16
 
16
 function getClassesInFile(templateData) {
17
 function getClassesInFile(templateData) {
23
   return classNames;
24
   return classNames;
24
 }
25
 }
25
 
26
 
26
-function createDocFileForClass(className, templateData, outputDir) {
27
+function createDocFileForClass({ className, templateData, outputDir, partial = [] }) {
27
   const template = `{{#class name="${className}"}}{{>docs}}{{/class}}`;
28
   const template = `{{#class name="${className}"}}{{>docs}}{{/class}}`;
28
   const options = {
29
   const options = {
29
     data: templateData,
30
     data: templateData,
30
     template,
31
     template,
31
     separators: true,
32
     separators: true,
32
-    partial
33
+    partial: [...PARTIALS, ...partial]
33
   };
34
   };
34
-  console.log(`rendering ${className}, template: ${template} ${outputDir}`);
35
+  console.log(`rendering ${className}`);
35
   const output = jsdoc2md.renderSync(options);
36
   const output = jsdoc2md.renderSync(options);
36
   fs.writeFileSync(path.resolve(outputDir, `${className}.md`), output);
37
   fs.writeFileSync(path.resolve(outputDir, `${className}.md`), output);
37
 }
38
 }
39
 function inputFiles() {
40
 function inputFiles() {
40
   return [
41
   return [
41
     { file: './lib/src/Navigation.js', outputDir: OUTPUT_DIR },
42
     { file: './lib/src/Navigation.js', outputDir: OUTPUT_DIR },
42
-    ...fs.readdirSync(optionsDir).map((file) => {
43
+    ...fs.readdirSync(OPTIONS_DIR).map((file) => {
43
       return {
44
       return {
44
-        file: optionsDir + file,
45
-        outputDir: OUTPUT_DIR + 'options/'
45
+        file: OPTIONS_DIR + file,
46
+        outputDir: OUTPUT_DIR + 'options/',
47
+        partial: OPTION_PARTIALS
46
       };
48
       };
47
     }),
49
     }),
48
-    ...fs.readdirSync(paramsDir)
49
-        .filter((file) => fs.statSync(paramsDir + file).isFile())
50
+    ...fs.readdirSync(PARAMS_DIR)
51
+        .filter((file) => fs.statSync(PARAMS_DIR + file).isFile())
50
         .map((file) => {
52
         .map((file) => {
51
           return {
53
           return {
52
-            file: paramsDir + file,
54
+            file: PARAMS_DIR + file,
53
             outputDir: OUTPUT_DIR
55
             outputDir: OUTPUT_DIR
54
           };
56
           };
55
         })
57
         })