Document the noComments parameter

SwiftGen · May 12, 2017 · aa1708a · aa1708a
1 parent cb3b14a
commit aa1708a
Show file tree

Hide file tree

Showing 14 changed files with 16 additions and 12 deletions.
diff --git a/Documentation/colors/swift2.md b/Documentation/colors/swift2.md
@@ -14,7 +14,7 @@
 
 ## Customization
 
-You can customize some elements of this template by overriding the following parameters when invoking `swiftgen` in the command line, using `--param <paramName> <newValue>`
+You can customize some elements of this template by overriding the following parameters when invoking `swiftgen` in the command line, using `--param <paramName>=<newValue>`
 
 | Parameter Name | Default Value | Description |
 | -------------- | ------------- | ----------- |

diff --git a/Documentation/colors/swift3.md b/Documentation/colors/swift3.md
@@ -14,7 +14,7 @@
 
 ## Customization
 
-You can customize some elements of this template by overriding the following parameters when invoking `swiftgen` in the command line, using `--param <paramName> <newValue>`
+You can customize some elements of this template by overriding the following parameters when invoking `swiftgen` in the command line, using `--param <paramName>=<newValue>`
 
 | Parameter Name | Default Value | Description |
 | -------------- | ------------- | ----------- |

diff --git a/Documentation/fonts/swift2.md b/Documentation/fonts/swift2.md
@@ -13,7 +13,7 @@
 
 ## Customization
 
-You can customize some elements of this template by overriding the following parameters when invoking `swiftgen` in the command line, using `--param <paramName> <newValue>`
+You can customize some elements of this template by overriding the following parameters when invoking `swiftgen` in the command line, using `--param <paramName>=<newValue>`
 
 | Parameter Name | Default Value | Description |
 | -------------- | ------------- | ----------- |

diff --git a/Documentation/fonts/swift3.md b/Documentation/fonts/swift3.md
@@ -13,7 +13,7 @@
 
 ## Customization
 
-You can customize some elements of this template by overriding the following parameters when invoking `swiftgen` in the command line, using `--param <paramName> <newValue>`
+You can customize some elements of this template by overriding the following parameters when invoking `swiftgen` in the command line, using `--param <paramName>=<newValue>`
 
 | Parameter Name | Default Value | Description |
 | -------------- | ------------- | ----------- |

diff --git a/Documentation/images/swift2.md b/Documentation/images/swift2.md
@@ -15,7 +15,7 @@ It also takes into account any namespacing folder in your Assets Catalogs (i.e.
 
 ## Customization
 
-You can customize some elements of this template by overriding the following parameters when invoking `swiftgen` in the command line, using `--param <paramName> <newValue>`
+You can customize some elements of this template by overriding the following parameters when invoking `swiftgen` in the command line, using `--param <paramName>=<newValue>`
 
 | Parameter Name | Default Value | Description |
 | -------------- | ------------- | ----------- |

diff --git a/Documentation/images/swift3.md b/Documentation/images/swift3.md
@@ -15,7 +15,7 @@ It also takes into account any namespacing folder in your Assets Catalogs (i.e.
 
 ## Customization
 
-You can customize some elements of this template by overriding the following parameters when invoking `swiftgen` in the command line, using `--param <paramName> <newValue>`
+You can customize some elements of this template by overriding the following parameters when invoking `swiftgen` in the command line, using `--param <paramName>=<newValue>`
 
 | Parameter Name | Default Value | Description |
 | -------------- | ------------- | ----------- |

diff --git a/Documentation/storyboards/osx-swift2.md b/Documentation/storyboards/osx-swift2.md
@@ -14,7 +14,7 @@
 
 ## Customization
 
-You can customize some elements of this template by overriding the following parameters when invoking `swiftgen` in the command line, using `--param <paramName> <newValue>`
+You can customize some elements of this template by overriding the following parameters when invoking `swiftgen` in the command line, using `--param <paramName>=<newValue>`
 
 | Parameter Name | Default Value | Description |
 | -------------- | ------------- | ----------- |

diff --git a/Documentation/storyboards/osx-swift3.md b/Documentation/storyboards/osx-swift3.md
@@ -14,7 +14,7 @@
 
 ## Customization
 
-You can customize some elements of this template by overriding the following parameters when invoking `swiftgen` in the command line, using `--param <paramName> <newValue>`
+You can customize some elements of this template by overriding the following parameters when invoking `swiftgen` in the command line, using `--param <paramName>=<newValue>`
 
 | Parameter Name | Default Value | Description |
 | -------------- | ------------- | ----------- |

diff --git a/Documentation/storyboards/swift2.md b/Documentation/storyboards/swift2.md
@@ -14,7 +14,7 @@
 
 ## Customization
 
-You can customize some elements of this template by overriding the following parameters when invoking `swiftgen` in the command line, using `--param <paramName> <newValue>`
+You can customize some elements of this template by overriding the following parameters when invoking `swiftgen` in the command line, using `--param <paramName>=<newValue>`
 
 | Parameter Name | Default Value | Description |
 | -------------- | ------------- | ----------- |

diff --git a/Documentation/storyboards/swift3.md b/Documentation/storyboards/swift3.md
@@ -14,7 +14,7 @@
 
 ## Customization
 
-You can customize some elements of this template by overriding the following parameters when invoking `swiftgen` in the command line, using `--param <paramName> <newValue>`
+You can customize some elements of this template by overriding the following parameters when invoking `swiftgen` in the command line, using `--param <paramName>=<newValue>`
 
 | Parameter Name | Default Value | Description |
 | -------------- | ------------- | ----------- |

diff --git a/Documentation/strings/flat-swift2.md b/Documentation/strings/flat-swift2.md
@@ -14,11 +14,12 @@
 
 ## Customization
 
-You can customize some elements of this template by overriding the following parameters when invoking `swiftgen` in the command line, using `--param <paramName> <newValue>`
+You can customize some elements of this template by overriding the following parameters when invoking `swiftgen` in the command line, using `--param <paramName>=<newValue>`
 
 | Parameter Name | Default Value | Description |
 | -------------- | ------------- | ----------- |
 | `enumName` | `L10n` | Allows you to change the name of the generated `enum` containing all string tables. |
+| `noComments` | N/A | Setting this parameter will disable the comments describing the translation of a key. |
 
 ## Generated Code
 

diff --git a/Documentation/strings/flat-swift3.md b/Documentation/strings/flat-swift3.md
@@ -14,11 +14,12 @@
 
 ## Customization
 
-You can customize some elements of this template by overriding the following parameters when invoking `swiftgen` in the command line, using `--param <paramName> <newValue>`
+You can customize some elements of this template by overriding the following parameters when invoking `swiftgen` in the command line, using `--param <paramName>=<newValue>`
 
 | Parameter Name | Default Value | Description |
 | -------------- | ------------- | ----------- |
 | `enumName` | `L10n` | Allows you to change the name of the generated `enum` containing all string tables. |
+| `noComments` | N/A | Setting this parameter will disable the comments describing the translation of a key. |
 
 ## Generated Code
 

diff --git a/Documentation/strings/structured-swift2.md b/Documentation/strings/structured-swift2.md
@@ -25,6 +25,7 @@ You can customize some elements of this template by overriding the following par
 | Parameter Name | Default Value | Description |
 | -------------- | ------------- | ----------- |
 | `enumName` | `L10n` | Allows you to change the name of the generated `enum` containing all string tables. |
+| `noComments` | N/A | Setting this parameter will disable the comments describing the translation of a key. |
 
 ## Generated Code
 

diff --git a/Documentation/strings/structured-swift3.md b/Documentation/strings/structured-swift3.md
@@ -25,6 +25,7 @@ You can customize some elements of this template by overriding the following par
 | Parameter Name | Default Value | Description |
 | -------------- | ------------- | ----------- |
 | `enumName` | `L10n` | Allows you to change the name of the generated `enum` containing all string tables. |
+| `noComments` | N/A | Setting this parameter will disable the comments describing the translation of a key. |
 
 ## Generated Code