*.kt: fixed consecutive KDOC error for ktLint

This commit is contained in:
tristan81 2024-09-18 23:25:53 +10:00
parent 4717ce0a58
commit 9d9cd5ae04
8 changed files with 58 additions and 87 deletions

View file

@ -27,12 +27,8 @@ class Media constructor(
*/ */
var filename: String? = null, var filename: String? = null,
/** /**
* Gets the file description. * Gets or sets the file description.
* @return file description as a string * @return file description as a string
*/
// monolingual description on input...
/**
* Sets the file description.
* @param fallbackDescription the new description of the file * @param fallbackDescription the new description of the file
*/ */
var fallbackDescription: String? = null, var fallbackDescription: String? = null,
@ -43,22 +39,15 @@ class Media constructor(
*/ */
var dateUploaded: Date? = null, var dateUploaded: Date? = null,
/** /**
* Gets the license name of the file. * Gets or sets the license name of the file.
* @return license as a String * @return license as a String
*/
/**
* Sets the license name of the file.
*
* @param license license name as a String * @param license license name as a String
*/ */
var license: String? = null, var license: String? = null,
var licenseUrl: String? = null, var licenseUrl: String? = null,
/** /**
* Gets the name of the creator of the file. * Gets or sets the name of the creator of the file.
* @return author name as a String * @return author name as a String
*/
/**
* Sets the author name of the file.
* @param author creator name as a string * @param author creator name as a string
*/ */
var author: String? = null, var author: String? = null,

View file

@ -6,15 +6,12 @@ class Bookmark(
mediaName: String?, mediaName: String?,
mediaCreator: String?, mediaCreator: String?,
/** /**
* Modifies the content URI - marking this bookmark as already saved in the database * Gets or Sets the content URI - marking this bookmark as already saved in the database
* @return content URI
* @param contentUri the content URI * @param contentUri the content URI
*/ */
var contentUri: Uri?, var contentUri: Uri?,
) { ) {
/**
* Gets the content URI for this bookmark
* @return content URI
*/
/** /**
* Gets the media name * Gets the media name
* @return the media name * @return the media name

View file

@ -30,8 +30,7 @@ data class Contribution constructor(
var errorInfo: String? = null, var errorInfo: String? = null,
/** /**
* @return array list of entityids for the depictions * @return array list of entityids for the depictions
*/ *
/**
* Each depiction loaded in depictions activity is associated with a wikidata entity id, this Id * Each depiction loaded in depictions activity is associated with a wikidata entity id, this Id
* is in turn used to upload depictions to wikibase * is in turn used to upload depictions to wikibase
*/ */

View file

@ -7,14 +7,7 @@ import java.util.Date
* Represents a recently searched query * Represents a recently searched query
* Example - query = "butterfly" * Example - query = "butterfly"
*/ */
class RecentSearch class RecentSearch(
/**
* Constructor
* @param contentUri the content URI for this query
* @param query query name
* @param lastSearched last searched date
*/
(
/** /**
* Modifies the content URI - marking this query as already saved in the database * Modifies the content URI - marking this query as already saved in the database
* *

View file

@ -5,49 +5,38 @@ package fr.free.nrw.commons.profile.achievements
*/ */
class Achievements { class Achievements {
/** /**
* getter function to get count of unique images used by wiki * The count of unique images used by the wiki.
* @return * @return The count of unique images used.
*/ * @param uniqueUsedImages The count to set for unique images used.
/**
* setter function to set count of uniques images used by wiki
* @param uniqueUsedImages
*/ */
var uniqueUsedImages = 0 var uniqueUsedImages = 0
private var articlesUsingImages = 0 private var articlesUsingImages = 0
/** /**
* getter function to get count of thanks received * The count of thanks received.
* @return * @return The count of thanks received.
*/ * @param thanksReceived The count to set for thanks received.
/**
* setter function to set count of thanks received
* @param thanksReceived
*/ */
var thanksReceived = 0 var thanksReceived = 0
/** /**
* getter function to get count of featured images * The count of featured images.
* @return * @return The count of featured images.
*/ * @param featuredImages The count to set for featured images.
/**
* setter function to set count of featured images
* @param featuredImages
*/ */
var featuredImages = 0 var featuredImages = 0
/** /**
* getter function to get count of featured images * The count of quality images.
* @return * @return The count of quality images.
*/ * @param qualityImages The count to set for quality images.
/**
* setter function to set count of featured images
* @param featuredImages
*/ */
var qualityImages = 0 var qualityImages = 0
/** /**
* getter function to get count of images uploaded * The count of images uploaded.
* @return * @return The count of images uploaded.
*/ * @param imagesUploaded The count to set for images uploaded.
/**
* setter function to count of images uploaded
* @param imagesUploaded
*/ */
var imagesUploaded = 0 var imagesUploaded = 0
private var revertCount = 0 private var revertCount = 0

View file

@ -5,27 +5,27 @@ package fr.free.nrw.commons.upload
*/ */
class Description { class Description {
/** /**
* @return The language code ie. "en" or "fr" * The language code, e.g., "en" or "fr".
*/ * @param languageCode The language code.
/**
* @param languageCode The language code ie. "en" or "fr"
*/ */
var languageCode: String? = null var languageCode: String? = null
var descriptionText: String? = null
/** /**
* @return the index of the language selected in a spinner with [SpinnerLanguagesAdapter] * The description text for the item being uploaded.
* @param descriptionText The description text.
*/ */
var descriptionText: String? = null
/** /**
* @param selectedLanguageIndex the index of the language selected in a spinner with [SpinnerLanguagesAdapter] * The index of the language selected in a spinner with [SpinnerLanguagesAdapter].
* @param selectedLanguageIndex The index of the selected language.
*/ */
var selectedLanguageIndex = -1 var selectedLanguageIndex = -1
/** /**
* returns if the description was added manually (by the user, or we have added it programaticallly) * Indicates if the description was added manually (by the user or programmatically).
* @return * @param manuallyAdded Sets to true if the description was manually added by the user.
*/ * @return True if the description was manually added.
/**
* sets to true if the description was manually added by the user
* @param manuallyAdded
*/ */
var isManuallyAdded = false var isManuallyAdded = false

View file

@ -24,10 +24,11 @@ class ImageCoordinates internal constructor(
* @return string of `"[decLatitude]|[decLongitude]"` or null if coordinates do not exist * @return string of `"[decLatitude]|[decLongitude]"` or null if coordinates do not exist
*/ */
var decimalCoords: String? = null var decimalCoords: String? = null
var zoomLevel: Double = 16.0
/** /**
* @return double value of zoom or 16.0 by default * @return double value of zoom or 16.0 by default
*/ */
var zoomLevel: Double = 16.0
/** /**
* Construct from a stream. * Construct from a stream.

View file

@ -10,13 +10,19 @@ import kotlinx.parcelize.Parcelize
@Parcelize @Parcelize
data class UploadMediaDetail constructor( data class UploadMediaDetail constructor(
/** /**
* @return The language code ie. "en" or "fr" * The language code ie. "en" or "fr".
*/ * @param languageCode The language code ie. "en" or "fr".
/**
* @param languageCode The language code ie. "en" or "fr"
*/ */
var languageCode: String? = null, var languageCode: String? = null,
/**
* The description text for the item being uploaded.
* @param descriptionText The description text.
*/
var descriptionText: String = "", var descriptionText: String = "",
/**
* The caption text for the item being uploaded.
* @param captionText The caption text.
*/
var captionText: String = "", var captionText: String = "",
) : Parcelable { ) : Parcelable {
fun javaCopy() = copy() fun javaCopy() = copy()
@ -26,21 +32,18 @@ data class UploadMediaDetail constructor(
place.longDescription, place.longDescription,
place.name, place.name,
) )
/**
* @return the index of the language selected in a spinner with [SpinnerLanguagesAdapter]
*/
/** /**
* @param selectedLanguageIndex the index of the language selected in a spinner with [SpinnerLanguagesAdapter] * The index of the language selected in a spinner with [SpinnerLanguagesAdapter].
* @return The index of the selected language.
* @param selectedLanguageIndex The index of the language selected.
*/ */
var selectedLanguageIndex: Int = -1 var selectedLanguageIndex: Int = -1
/** /**
* returns if the description was added manually (by the user, or we have added it programaticallly) * Returns if the description was added manually (by the user, or programmatically).
* @return * @return True if the description was manually added.
*/ * @param manuallyAdded Sets to true if the description was manually added.
/**
* sets to true if the description was manually added by the user
* @param manuallyAdded
*/ */
var isManuallyAdded: Boolean = false var isManuallyAdded: Boolean = false
} }