javadoc cleanup

Author: ajungg

core/src/main/java/io/snabble/sdk/CustomerCardInfo.kt

@@ -8,6 +8,7 @@ data class CustomerCardInfo(
      * Unique id of the customer card type
      **/
     val cardId: String,
+
     /**
      * True if the customer card is required for checkout, false otherwise
      */

core/src/main/java/io/snabble/sdk/Environment.kt

@@ -12,6 +12,7 @@ enum class Environment(domain: String) {
      * Get the base url used for every request made from the sdk
      */
     val baseUrl: String = "https://api.$domain"
+
     /**
      * Get a wildcard url, for certificate pinning
      */

core/src/main/java/io/snabble/sdk/FulfillmentState.kt

@@ -4,7 +4,7 @@ import com.google.gson.annotations.SerializedName
 import io.snabble.sdk.FulfillmentState
 
 /**
- * Enum class describing the state of a fulfillment.
+ * Enum class describing the state of a fulfillment
  */
 enum class FulfillmentState {
     @SerializedName("open")
@@ -38,7 +38,7 @@ enum class FulfillmentState {
         }
 
     /**
-     * Returns true if the current fulfillment has failed. This state is final.
+     * Returns true if the current fulfillment has failed. This state is final
      */
     val isFailure: Boolean
         get() = when(this) {
@@ -50,7 +50,7 @@ enum class FulfillmentState {
         }
 
     /**
-     * Returns true if the current fulfillment is closed, successful or not. This state is final.
+     * Returns true if the current fulfillment is closed, successful or not. This state is final
      */
     val isClosed: Boolean
         get() = when(this) {

core/src/main/java/io/snabble/sdk/PaymentMethod.kt

@@ -4,7 +4,7 @@ import androidx.annotation.Nullable
 import com.google.gson.annotations.SerializedName
 
 /**
- * Enum class describing payment methods.
+ * Enum class describing payment methods
  */
 enum class PaymentMethod(
     /**

core/src/main/java/io/snabble/sdk/PriceFormatter.kt

@@ -7,7 +7,7 @@ import java.math.BigDecimal
 import java.text.NumberFormat
 
 /**
- * A price formatter for formatting prices using the provided currency information.
+ * A price formatter for formatting prices using the provided currency information
  *
  */
 class PriceFormatter(private val project: Project) {
@@ -22,7 +22,7 @@ class PriceFormatter(private val project: Project) {
     }
 
     /**
-     * Format a price.
+     * Format a price
      */
     @JvmOverloads
     fun format(price: Int, allowZeroPrice: Boolean = true): String {

core/src/main/java/io/snabble/sdk/Product.java

@@ -26,7 +26,7 @@
 public class Product implements Serializable, Parcelable {
     public enum Type {
         /**
-         * A basic product with price information.
+         * A basic product with price information
          */
         Article(0),
 
@@ -224,14 +224,14 @@ public int getListPrice() {
     }
 
     /**
-     * Gets the subtitle of the product. Most of the time it is the Brand name of the product.
+     * Gets the subtitle of the product. Most of the time it is the Brand name of the product
      */
     public String getSubtitle() {
         return subtitle;
     }
 
     /**
-     * Gets the discounted price, or the default price if this product has no discounted price,
+     * Gets the discounted price, or the default price if this product has no discounted price
      */
     public int getDiscountedPrice() {
         return discountedPrice == 0 ? getListPrice() : discountedPrice;
@@ -301,14 +301,14 @@ public String getBasePrice() {
     }
 
     /**
-     * @return The {@link Type} of the product.
+     * @return The {@link Type} of the product
      */
     public Type getType() {
         return type;
     }
 
     /**
-     * @return The [@link SaleRestriction} of the product.
+     * @return The [@link SaleRestriction} of the product
      */
     public SaleRestriction getSaleRestriction() {
         return saleRestriction;
@@ -386,14 +386,14 @@ public Product.Code getPrimaryCode() {
     }
 
     /**
-     * Returns true if this product should not be available for sale anymore.
+     * Returns true if this product should not be available for sale anymore
      */
     public boolean getSaleStop() {
         return saleStop;
     }
 
     /**
-     * Returns true if this product is not for sale.
+     * Returns true if this product is not for sale
      */
     public boolean getNotForSale() {
         return notForSale;
@@ -412,7 +412,7 @@ public String getScanMessage() {
     }
 
     /**
-     * Returns the price for a given quantity. Get encoded into its encoding unit, if required.
+     * Returns the price for a given quantity. Get encoded into its encoding unit, if required
      */
     public int getPriceForQuantity(int quantity, ScannedCode scannedCode, RoundingMode roundingMode) {
         return getPriceForQuantity(quantity, scannedCode, roundingMode, null);

core/src/main/java/io/snabble/sdk/Project.kt

@@ -28,7 +28,7 @@ import java.util.concurrent.CopyOnWriteArrayList
  */
 class Project internal constructor(jsonObject: JsonObject) {
     /**
-     * The unique identifier of the Project.
+     * The unique identifier of the Project
      */
     lateinit var id: String
         private set
@@ -55,7 +55,7 @@ class Project internal constructor(jsonObject: JsonObject) {
         private set
 
     /**
-     * The roundingMode which should be used when doing offline calculations.
+     * The roundingMode which should be used when doing offline calculations
      */
     var roundingMode: RoundingMode = RoundingMode.HALF_UP
         private set
@@ -67,13 +67,13 @@ class Project internal constructor(jsonObject: JsonObject) {
         private set
 
     /**
-     * The locale in which this currency is used.
+     * The locale in which this currency is used
      */
     lateinit var currencyLocale: Locale
         private set
 
     /**
-     * The number of used currency fractions digits.
+     * The number of used currency fractions digits
      */
     var currencyFractionDigits = -1
         get() =
@@ -90,27 +90,27 @@ class Project internal constructor(jsonObject: JsonObject) {
 
     /**
      * Parameters in which codes used for offline processing
-     * (for example: Checkout using a QR-Code) should be encoded.
+     * (for example: Checkout using a QR-Code) should be encoded
      */
     var encodedCodesOptions: EncodedCodesOptions? = null
         private set
 
     /**
      * List of supported barcode formats used by this retailer. The scanner should restrict its
-     * scanning to include only those formats.
+     * scanning to include only those formats
      */
     var supportedBarcodeFormats = emptyList<BarcodeFormat>()
         private set
 
     /**
-     * Indicator if prices should be displayed using the net price instead of the gross price.
+     * Indicator if prices should be displayed using the net price instead of the gross price
      */
     var isDisplayingNetPrice = false
         private set
 
     /**
      * List of payment method descriptors indicating which
-     * payment methods and providers are available in the Project.
+     * payment methods and providers are available in the Project
      */
     var paymentMethodDescriptors: List<PaymentMethodDescriptor> = emptyList()
         private set
@@ -126,7 +126,7 @@ class Project internal constructor(jsonObject: JsonObject) {
         private set
 
     /**
-     * Returns the possible accepted cards and if a customer card is required.
+     * Returns the possible accepted cards and if a customer card is required
      */
     var customerCardInfo = emptyList<CustomerCardInfo>()
         private set
@@ -141,7 +141,7 @@ class Project internal constructor(jsonObject: JsonObject) {
         private set
 
     /**
-     * Sets the customer card number for user identification with the backend.
+     * Sets the customer card number for user identification with the backend
      */
     var customerCardId: String? = null
         set(value) {
@@ -171,13 +171,13 @@ class Project internal constructor(jsonObject: JsonObject) {
 
     /**
      * List of code templates that are used when supplying an existing Product with a different
-     * barcode which contains a reduced price.
+     * barcode which contains a reduced price
      */
     var priceOverrideTemplates = emptyList<PriceOverrideTemplate>()
         private set
 
     /**
-     * List of code templates that are searchable using the barcode search functionality.
+     * List of code templates that are searchable using the barcode search functionality
      */
     var searchableTemplates = emptyList<String>()
         private set
@@ -198,7 +198,7 @@ class Project internal constructor(jsonObject: JsonObject) {
         private set
 
     /**
-     * Url to retrieve authentication tokens.
+     * Url to retrieve authentication tokens
      */
     var tokensUrl: String? = null
         private set
@@ -301,13 +301,13 @@ class Project internal constructor(jsonObject: JsonObject) {
         private set
 
     /**
-     * The primary product database of this project.
+     * The primary product database of this project
      */
     lateinit var productDatabase: ProductDatabase
         private set
 
     /**
-     * Event logger which ships logging data to the snabble backend.
+     * Event logger which ships logging data to the snabble backend
      */
     lateinit var events: Events
         private set
@@ -323,7 +323,7 @@ class Project internal constructor(jsonObject: JsonObject) {
     }
 
     /**
-     * Parse a json definition of a Project.
+     * Parse a json definition of a Project
      */
     fun parse(jsonObject: JsonObject) {
         id = requireNotNull(jsonObject["id"]?.asString) { "Project has no id" }
@@ -563,7 +563,7 @@ class Project internal constructor(jsonObject: JsonObject) {
         }
 
     /**
-     * List of payment methods that should be available to the user.
+     * List of payment methods that should be available to the user
      */
     val availablePaymentMethods
         get() = paymentMethodDescriptors.map { it.paymentMethod }
@@ -589,22 +589,22 @@ class Project internal constructor(jsonObject: JsonObject) {
         }
 
     /**
-     * Get text included in the metadata.
+     * Get text included in the metadata
      */
     @JvmOverloads
     fun getText(key: String, defaultValue: String? = null) =
         texts[key] ?: defaultValue
 
     /**
-     * Logs a event tagged with error to the snabble Backend.
+     * Logs a event tagged with error to the snabble Backend
      */
     fun logErrorEvent(format: String?, vararg args: Any?) {
         Logger.e(format, *args)
         events.logError(format, *args)
     }
 
     /**
-     * Logs a event to the snabble Backend.
+     * Logs a event to the snabble Backend
      */
     fun logEvent(format: String?, vararg args: Any?) {
         Logger.e(format, *args)

core/src/main/java/io/snabble/sdk/Receipts.kt

@@ -66,7 +66,7 @@ class Receipts internal constructor() {
     }
 
     /**
-     * Downloads a receipts pdf and stores it in the projects internal storage directory.
+     * Downloads a receipts pdf and stores it in the projects internal storage directory
      */
     fun download(receiptInfo: ReceiptInfo, callback: ReceiptDownloadCallback?) {
         if (receiptInfo.pdfUrl == null) {

core/src/main/java/io/snabble/sdk/ShoppingCart.java

@@ -31,7 +31,7 @@
 import io.snabble.sdk.utils.GsonHolder;
 
 /**
- * Class representing the snabble shopping cart.
+ * Class representing the snabble shopping cart
  */
 public class ShoppingCart implements Iterable<ShoppingCart.Item> {
     public static final int MAX_QUANTITY = 99999;
@@ -128,7 +128,7 @@ void initWithProject(Project project) {
     }
 
     /**
-     * The id used to identify this cart session.
+     * The id used to identify this cart session
      */
     public String getId() {
         return id;