Update docs

This commit is contained in:
Daniel Saidi 2021-11-15 10:33:25 +01:00
parent 91b96cb9f6
commit bdd9c0544c
4 changed files with 9 additions and 8 deletions

View File

@ -3,7 +3,7 @@
## 1.0
After a lot of waiting and stabilizing, I think it's time to push the major release button.
I think it's finally time to push the major release button.
This version drastically improves documentation and ships with a DocC documentation archive.

View File

@ -9,11 +9,11 @@
import Foundation
/**
This protocol can be implemented by a class that implements
`Translator` and also can change the the app's locale.
This protocol can be implemented any ``Translator`` that is
also capable of changing the app's current locale.
`LocalizationService` should post `LocalizationNotification`
notifications when the app locale changes.
Implementations of this protocol should make sure to post a
``LocalizationNotification`` when the app locale changes.
*/
public protocol LocalizationService: Translator {

View File

@ -9,7 +9,8 @@
import Foundation
/**
This `Translator` translates keys using `NSLocalizedString`.
This standard ``Translator`` implementation translates keys
using `NSLocalizedString`.
*/
public class StandardTranslator: Translator {

View File

@ -9,8 +9,8 @@
import Foundation
/**
This protocol can be implemented by any class that can take
a localization key and translate it in one way or another.
This protocol can be implemented by any classes that can be
used to translate a localized string synchronously.
*/
public protocol Translator: AnyObject {