Skip to content

Commit 09dc831

Browse files
committed
Update docs
1 parent 2e29238 commit 09dc831

File tree

4 files changed

+4
-4
lines changed

4 files changed

+4
-4
lines changed

Documentation/templates/strings/flat-swift4.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ You can customize some elements of this template by overriding the following par
2121
| `enumName` | `L10n` | Allows you to change the name of the generated `enum` containing all string tables. |
2222
| `noComments` | N/A | Setting this parameter will disable the comments describing the translation of a key. |
2323
| `publicAccess` | N/A | If set, the generated constants will be marked as `public`. Otherwise, they'll be declared `internal`. |
24-
| `localizeFunction` | `NSLocalizedString` | Allows you to set your own custom localization function. Your custom function must have the same signature as the one provided by `Foundation`, i.e. `yourFunctionName(_:tableName:bundle:comment:)` |
24+
| `lookupFunction` | N/A | Allows you to set your own custom localization function. The function needs to accepts 2 parameters: the localization key (`String`), and the localization table (`String`). If the function has named parameters, you must provide the complete function signature, including those named parameters – e.g. `yourFunctionName(forKey:table:)`. |
2525
| `forceFileNameEnum` | N/A | Setting this parameter will generate an `enum <FileName>` _even if_ only one FileName was provided as input. |
2626

2727
## Generated Code

Documentation/templates/strings/flat-swift5.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ You can customize some elements of this template by overriding the following par
2121
| `enumName` | `L10n` | Allows you to change the name of the generated `enum` containing all string tables. |
2222
| `noComments` | N/A | Setting this parameter will disable the comments describing the translation of a key. |
2323
| `publicAccess` | N/A | If set, the generated constants will be marked as `public`. Otherwise, they'll be declared `internal`. |
24-
| `localizeFunction` | `NSLocalizedString` | Allows you to set your own custom localization function. Your custom function must have the same signature as the one provided by `Foundation`, i.e. `yourFunctionName(_:tableName:bundle:comment:)` |
24+
| `lookupFunction` | N/A | Allows you to set your own custom localization function. The function needs to accepts 2 parameters: the localization key (`String`), and the localization table (`String`). If the function has named parameters, you must provide the complete function signature, including those named parameters – e.g. `yourFunctionName(forKey:table:)`. |
2525
| `forceFileNameEnum` | N/A | Setting this parameter will generate an `enum <FileName>` _even if_ only one FileName was provided as input. |
2626

2727
## Generated Code

Documentation/templates/strings/structured-swift4.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ You can customize some elements of this template by overriding the following par
2727
| `enumName` | `L10n` | Allows you to change the name of the generated `enum` containing all string tables. |
2828
| `noComments` | N/A | Setting this parameter will disable the comments describing the translation of a key. |
2929
| `publicAccess` | N/A | If set, the generated constants will be marked as `public`. Otherwise, they'll be declared `internal`. |
30-
| `localizeFunction` | `NSLocalizedString` | Allows you to set your own custom localization function. Your custom function must have the same signature as the one provided by `Foundation`, i.e. `yourFunctionName(_:tableName:bundle:comment:)` |
30+
| `lookupFunction` | N/A | Allows you to set your own custom localization function. The function needs to accepts 2 parameters: the localization key (`String`), and the localization table (`String`). If the function has named parameters, you must provide the complete function signature, including those named parameters – e.g. `yourFunctionName(forKey:table:)`. |
3131
| `forceFileNameEnum` | N/A | Setting this parameter will generate an `enum <FileName>` _even if_ only one FileName was provided as input. |
3232

3333
## Generated Code

Documentation/templates/strings/structured-swift5.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ You can customize some elements of this template by overriding the following par
2727
| `enumName` | `L10n` | Allows you to change the name of the generated `enum` containing all string tables. |
2828
| `noComments` | N/A | Setting this parameter will disable the comments describing the translation of a key. |
2929
| `publicAccess` | N/A | If set, the generated constants will be marked as `public`. Otherwise, they'll be declared `internal`. |
30-
| `localizeFunction` | `NSLocalizedString` | Allows you to set your own custom localization function. Your custom function must have the same signature as the one provided by `Foundation`, i.e. `yourFunctionName(_:tableName:bundle:comment:)` |
30+
| `lookupFunction` | N/A | Allows you to set your own custom localization function. The function needs to accepts 2 parameters: the localization key (`String`), and the localization table (`String`). If the function has named parameters, you must provide the complete function signature, including those named parameters – e.g. `yourFunctionName(forKey:table:)`. |
3131
| `forceFileNameEnum` | N/A | Setting this parameter will generate an `enum <FileName>` _even if_ only one FileName was provided as input. |
3232

3333
## Generated Code

0 commit comments

Comments
 (0)