Merge pull request #74 from transifex/fix/documentation

Improve documentation

README.md

@@ -12,7 +12,7 @@ The SDK can fetch translations over the air (OTA), manages an internal cache of
 and works seamlessly without requiring any changes in the source code of the app by the
 developer.
 
-Both Objective-C and Swift projects are supported.
+Both Objective-C and Swift projects are supported. SwiftUI is also supported as of v2.0.3.
 
 The package is built using Swift 5.3, as it currently requires a bundled resource to be
 present in the package (feature introduced in version 5.3).

Sources/Transifex/CDSHandler.swift

@@ -98,6 +98,16 @@ public final class TXPushConfiguration : NSObject {
     @objc
     public let dryRun: Bool
 
+    /// Initialize the push configuration object with the provided parameters.
+    ///
+    /// Refer to the documentation of each property for default values and more information.
+    ///
+    /// - Parameters:
+    ///   - purge: The purge content boolean flag.
+    ///   - overrideTags: The override tags boolean flag.
+    ///   - overrideOccurrences: The override occurrences boolean flag.
+    ///   - keepTranslations: The keep translations boolean flag.
+    ///   - dryRun: The dry run boolean flag.
     @objc
     public init(purge: Bool = false,
                 overrideTags: Bool = false,

Sources/Transifex/Plurals.swift

@@ -557,7 +557,7 @@ final class XMLPluralParser: NSObject {
 }
 
 extension XMLPluralParser : XMLParserDelegate {
-    public func parser(_ parser: XMLParser, didStartElement elementName: String,
+    func parser(_ parser: XMLParser, didStartElement elementName: String,
                 namespaceURI: String?, qualifiedName qName: String?,
                 attributes attributeDict: [String : String] = [:]) {
         guard elementName == TXNative.CDS_XML_TAG_NAME,
@@ -569,7 +569,7 @@ extension XMLPluralParser : XMLParserDelegate {
         pendingString = ""
     }
 
-    public func parser(_ parser: XMLParser, didEndElement elementName: String,
+    func parser(_ parser: XMLParser, didEndElement elementName: String,
                 namespaceURI: String?, qualifiedName qName: String?) {
         guard let cdsUnitID = pendingCDSUnitID else {
             return
@@ -579,7 +579,7 @@ extension XMLPluralParser : XMLParserDelegate {
         pendingString = ""
     }
 
-    public func parser(_ parser: XMLParser, foundCharacters string: String) {
+    func parser(_ parser: XMLParser, foundCharacters string: String) {
         guard let _ = pendingCDSUnitID else {
             return
         }