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,5 +8,3 @@
8 8
 | tabs | <code>Array.&lt;Container&gt;</code> | 
9 9
 
10 10
 
11
-* * *
12
-

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

@@ -9,5 +9,3 @@
9 9
 | passProps | <code>Object</code> | props |
10 10
 
11 11
 
12
-* * *
13
-

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

@@ -17,8 +17,6 @@
17 17
     * [.events()](#Navigation+events)
18 18
 
19 19
 
20
-* * *
21
-
22 20
 <a name="Navigation+registerContainer"></a>
23 21
 
24 22
 ### navigation.registerContainer(containerName, getContainerFunc)
@@ -31,8 +29,6 @@ Every screen component in your app must be registered with a unique name. The co
31 29
 | getContainerFunc | <code>function</code> | generator function, typically `() => require('./myContainer')` |
32 30
 
33 31
 
34
-* * *
35
-
36 32
 <a name="Navigation+setRoot"></a>
37 33
 
38 34
 ### navigation.setRoot(root)
@@ -44,8 +40,6 @@ Reset the navigation stack to a new screen (the stack root is changed).
44 40
 | root | <code>Root</code> | 
45 41
 
46 42
 
47
-* * *
48
-
49 43
 <a name="Navigation+setDefaultOptions"></a>
50 44
 
51 45
 ### navigation.setDefaultOptions(options)
@@ -57,8 +51,6 @@ Set default options to all screens. Useful for declaring a consistent style acro
57 51
 | options | <code>NavigationOptions</code> | 
58 52
 
59 53
 
60
-* * *
61
-
62 54
 <a name="Navigation+setOptions"></a>
63 55
 
64 56
 ### navigation.setOptions(containerId, options)
@@ -71,8 +63,6 @@ Change a containers navigation options
71 63
 | options | <code>NavigationOptions</code> |  |
72 64
 
73 65
 
74
-* * *
75
-
76 66
 <a name="Navigation+showModal"></a>
77 67
 
78 68
 ### navigation.showModal(params)
@@ -84,8 +74,6 @@ Show a screen as a modal.
84 74
 | params | <code>Object</code> | 
85 75
 
86 76
 
87
-* * *
88
-
89 77
 <a name="Navigation+dismissModal"></a>
90 78
 
91 79
 ### navigation.dismissModal(containerId)
@@ -97,16 +85,12 @@ Dismiss a modal by containerId. The dismissed modal can be anywhere in the stack
97 85
 | containerId | <code>String</code> | The container's id. |
98 86
 
99 87
 
100
-* * *
101
-
102 88
 <a name="Navigation+dismissAllModals"></a>
103 89
 
104 90
 ### navigation.dismissAllModals()
105 91
 Dismiss all Modals
106 92
 
107 93
 
108
-* * *
109
-
110 94
 <a name="Navigation+push"></a>
111 95
 
112 96
 ### navigation.push(containerId, params)
@@ -119,8 +103,6 @@ Push a new screen into this screen's navigation stack.
119 103
 | params | <code>\*</code> |  |
120 104
 
121 105
 
122
-* * *
123
-
124 106
 <a name="Navigation+pop"></a>
125 107
 
126 108
 ### navigation.pop(containerId, params)
@@ -133,8 +115,6 @@ Pop a container from the stack, regardless of it's position.
133 115
 | params | <code>\*</code> |  |
134 116
 
135 117
 
136
-* * *
137
-
138 118
 <a name="Navigation+popTo"></a>
139 119
 
140 120
 ### navigation.popTo(containerId)
@@ -146,8 +126,6 @@ Pop the stack to a given container
146 126
 | containerId | <code>String</code> | The container's id. |
147 127
 
148 128
 
149
-* * *
150
-
151 129
 <a name="Navigation+popToRoot"></a>
152 130
 
153 131
 ### navigation.popToRoot(containerId)
@@ -159,13 +137,9 @@ Pop the container's stack to root.
159 137
 | containerId | <code>\*</code> | 
160 138
 
161 139
 
162
-* * *
163
-
164 140
 <a name="Navigation+events"></a>
165 141
 
166 142
 ### navigation.events()
167 143
 Obtain the events registery instance
168 144
 
169 145
 
170
-* * *
171
-

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

@@ -10,5 +10,3 @@
10 10
 | bottomTabs | <code>BottomTabs</code> | 
11 11
 
12 12
 
13
-* * *
14
-

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

@@ -9,5 +9,3 @@
9 9
 | right | <code>Container</code> | 
10 10
 
11 11
 
12
-* * *
13
-

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

@@ -11,5 +11,3 @@
11 11
 | animateHide | <code>boolean</code> | 
12 12
 
13 13
 
14
-* * *
15
-

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

@@ -14,5 +14,3 @@
14 14
 | disabled | <code>boolean</code> | 
15 15
 
16 16
 
17
-* * *
18
-

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

@@ -11,5 +11,3 @@
11 11
 | leftButtons | <code>Button</code> | 
12 12
 
13 13
 
14
-* * *
15
-

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

@@ -15,5 +15,3 @@
15 15
 | transparent | <code>boolean</code> | 
16 16
 
17 17
 
18
-* * *
19
-

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

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

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

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