Browse Source

Remove separator from some doc files (#2398)

Guy Carmeli 6 years ago
parent
commit
401c0aa9d9
No account linked to committer's email address

+ 0
- 2
docs/docs/BottomTabs.md View File

8
 | tabs | <code>Array.&lt;Container&gt;</code> | 
8
 | tabs | <code>Array.&lt;Container&gt;</code> | 
9
 
9
 
10
 
10
 
11
-* * *
12
-

+ 0
- 2
docs/docs/Container.md View File

9
 | passProps | <code>Object</code> | props |
9
 | passProps | <code>Object</code> | props |
10
 
10
 
11
 
11
 
12
-* * *
13
-

+ 0
- 26
docs/docs/Navigation.md View File

17
     * [.events()](#Navigation+events)
17
     * [.events()](#Navigation+events)
18
 
18
 
19
 
19
 
20
-* * *
21
-
22
 <a name="Navigation+registerContainer"></a>
20
 <a name="Navigation+registerContainer"></a>
23
 
21
 
24
 ### navigation.registerContainer(containerName, getContainerFunc)
22
 ### navigation.registerContainer(containerName, getContainerFunc)
31
 | getContainerFunc | <code>function</code> | generator function, typically `() => require('./myContainer')` |
29
 | getContainerFunc | <code>function</code> | generator function, typically `() => require('./myContainer')` |
32
 
30
 
33
 
31
 
34
-* * *
35
-
36
 <a name="Navigation+setRoot"></a>
32
 <a name="Navigation+setRoot"></a>
37
 
33
 
38
 ### navigation.setRoot(root)
34
 ### navigation.setRoot(root)
44
 | root | <code>Root</code> | 
40
 | root | <code>Root</code> | 
45
 
41
 
46
 
42
 
47
-* * *
48
-
49
 <a name="Navigation+setDefaultOptions"></a>
43
 <a name="Navigation+setDefaultOptions"></a>
50
 
44
 
51
 ### navigation.setDefaultOptions(options)
45
 ### navigation.setDefaultOptions(options)
57
 | options | <code>NavigationOptions</code> | 
51
 | options | <code>NavigationOptions</code> | 
58
 
52
 
59
 
53
 
60
-* * *
61
-
62
 <a name="Navigation+setOptions"></a>
54
 <a name="Navigation+setOptions"></a>
63
 
55
 
64
 ### navigation.setOptions(containerId, options)
56
 ### navigation.setOptions(containerId, options)
71
 | options | <code>NavigationOptions</code> |  |
63
 | options | <code>NavigationOptions</code> |  |
72
 
64
 
73
 
65
 
74
-* * *
75
-
76
 <a name="Navigation+showModal"></a>
66
 <a name="Navigation+showModal"></a>
77
 
67
 
78
 ### navigation.showModal(params)
68
 ### navigation.showModal(params)
84
 | params | <code>Object</code> | 
74
 | params | <code>Object</code> | 
85
 
75
 
86
 
76
 
87
-* * *
88
-
89
 <a name="Navigation+dismissModal"></a>
77
 <a name="Navigation+dismissModal"></a>
90
 
78
 
91
 ### navigation.dismissModal(containerId)
79
 ### navigation.dismissModal(containerId)
97
 | containerId | <code>String</code> | The container's id. |
85
 | containerId | <code>String</code> | The container's id. |
98
 
86
 
99
 
87
 
100
-* * *
101
-
102
 <a name="Navigation+dismissAllModals"></a>
88
 <a name="Navigation+dismissAllModals"></a>
103
 
89
 
104
 ### navigation.dismissAllModals()
90
 ### navigation.dismissAllModals()
105
 Dismiss all Modals
91
 Dismiss all Modals
106
 
92
 
107
 
93
 
108
-* * *
109
-
110
 <a name="Navigation+push"></a>
94
 <a name="Navigation+push"></a>
111
 
95
 
112
 ### navigation.push(containerId, params)
96
 ### navigation.push(containerId, params)
119
 | params | <code>\*</code> |  |
103
 | params | <code>\*</code> |  |
120
 
104
 
121
 
105
 
122
-* * *
123
-
124
 <a name="Navigation+pop"></a>
106
 <a name="Navigation+pop"></a>
125
 
107
 
126
 ### navigation.pop(containerId, params)
108
 ### navigation.pop(containerId, params)
133
 | params | <code>\*</code> |  |
115
 | params | <code>\*</code> |  |
134
 
116
 
135
 
117
 
136
-* * *
137
-
138
 <a name="Navigation+popTo"></a>
118
 <a name="Navigation+popTo"></a>
139
 
119
 
140
 ### navigation.popTo(containerId)
120
 ### navigation.popTo(containerId)
146
 | containerId | <code>String</code> | The container's id. |
126
 | containerId | <code>String</code> | The container's id. |
147
 
127
 
148
 
128
 
149
-* * *
150
-
151
 <a name="Navigation+popToRoot"></a>
129
 <a name="Navigation+popToRoot"></a>
152
 
130
 
153
 ### navigation.popToRoot(containerId)
131
 ### navigation.popToRoot(containerId)
159
 | containerId | <code>\*</code> | 
137
 | containerId | <code>\*</code> | 
160
 
138
 
161
 
139
 
162
-* * *
163
-
164
 <a name="Navigation+events"></a>
140
 <a name="Navigation+events"></a>
165
 
141
 
166
 ### navigation.events()
142
 ### navigation.events()
167
 Obtain the events registery instance
143
 Obtain the events registery instance
168
 
144
 
169
 
145
 
170
-* * *
171
-

+ 0
- 2
docs/docs/Root.md View File

10
 | bottomTabs | <code>BottomTabs</code> | 
10
 | bottomTabs | <code>BottomTabs</code> | 
11
 
11
 
12
 
12
 
13
-* * *
14
-

+ 0
- 2
docs/docs/SideMenu.md View File

9
 | right | <code>Container</code> | 
9
 | right | <code>Container</code> | 
10
 
10
 
11
 
11
 
12
-* * *
13
-

+ 0
- 2
docs/docs/options/BottomTabs.md View File

11
 | animateHide | <code>boolean</code> | 
11
 | animateHide | <code>boolean</code> | 
12
 
12
 
13
 
13
 
14
-* * *
15
-

+ 0
- 2
docs/docs/options/Button.md View File

14
 | disabled | <code>boolean</code> | 
14
 | disabled | <code>boolean</code> | 
15
 
15
 
16
 
16
 
17
-* * *
18
-

+ 0
- 2
docs/docs/options/NavigationOptions.md View File

11
 | leftButtons | <code>Button</code> | 
11
 | leftButtons | <code>Button</code> | 
12
 
12
 
13
 
13
 
14
-* * *
15
-

+ 0
- 2
docs/docs/options/TopBar.md View File

15
 | transparent | <code>boolean</code> | 
15
 | transparent | <code>boolean</code> | 
16
 
16
 
17
 
17
 
18
-* * *
19
-

+ 1
- 1
docs/templates/docs.hbs View File

1
 {{>header~}}
1
 {{>header~}}
2
 {{>body}}
2
 {{>body}}
3
 {{>member-index~}}
3
 {{>member-index~}}
4
-{{>separator~}}
4
+{{#unless @last}}{{separator~}}{{/unless}}
5
 {{>members~}}
5
 {{>members~}}

+ 6
- 5
scripts/generate-js-doc.js View File

8
 const OPTION_PARTIALS = ['./docs/templates/header.hbs', './docs/templates/sig-name.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
 const PARTIALS = ['./docs/templates/scope.hbs', './docs/templates/docs.hbs'];
10
 
10
 
11
-const generateMarkdownForFile = ({ file, outputDir, partial }) => {
11
+const generateMarkdownForFile = ({ file, outputDir, partial, separator }) => {
12
   const templateData = jsdoc2md.getTemplateDataSync({ files: file });
12
   const templateData = jsdoc2md.getTemplateDataSync({ files: file });
13
   const classNames = getClassesInFile(templateData);
13
   const classNames = getClassesInFile(templateData);
14
-  classNames.forEach((className) => createDocFileForClass({ className, templateData, outputDir, partial }));
14
+  classNames.forEach((className) => createDocFileForClass({ className, templateData, outputDir, partial, separator }));
15
 };
15
 };
16
 
16
 
17
 function getClassesInFile(templateData) {
17
 function getClassesInFile(templateData) {
24
   return classNames;
24
   return classNames;
25
 }
25
 }
26
 
26
 
27
-function createDocFileForClass({ className, templateData, outputDir, partial = [] }) {
27
+function createDocFileForClass({ className, templateData, outputDir, partial = [], separator = true }) {
28
   const template = `{{#class name="${className}"}}{{>docs}}{{/class}}`;
28
   const template = `{{#class name="${className}"}}{{>docs}}{{/class}}`;
29
   const options = {
29
   const options = {
30
     data: templateData,
30
     data: templateData,
31
     template,
31
     template,
32
-    separators: true,
32
+    separators: separator,
33
     partial: [...PARTIALS, ...partial]
33
     partial: [...PARTIALS, ...partial]
34
   };
34
   };
35
   console.log(`rendering ${className}`);
35
   console.log(`rendering ${className}`);
44
       return {
44
       return {
45
         file: OPTIONS_DIR + file,
45
         file: OPTIONS_DIR + file,
46
         outputDir: OUTPUT_DIR + 'options/',
46
         outputDir: OUTPUT_DIR + 'options/',
47
-        partial: OPTION_PARTIALS
47
+        partial: OPTION_PARTIALS,
48
+        separator: false
48
       };
49
       };
49
     }),
50
     }),
50
     ...fs.readdirSync(PARAMS_DIR)
51
     ...fs.readdirSync(PARAMS_DIR)