Expand KDoc of inc() and dec() operators #KT-43701

This commit is contained in:
Abduqodiri Qurbonzoda
2021-01-18 00:50:15 +03:00
parent b311820159
commit 98d31a1813
16 changed files with 418 additions and 75 deletions
+11 -2
View File
@@ -38,9 +38,18 @@ public class Char private constructor() : Comparable<Char> {
/** Subtracts the other Int value from this value resulting a Char. */
public operator fun minus(other: Int): Char
/** Increments this value. */
/**
* Returns this value incremented by one.
*
* @sample samples.misc.Builtins.inc
*/
public operator fun inc(): Char
/** Decrements this value. */
/**
* Returns this value decremented by one.
*
* @sample samples.misc.Builtins.dec
*/
public operator fun dec(): Char
/** Creates a range from this value to the specified [other] value. */
+72 -12
View File
@@ -173,10 +173,20 @@ public class Byte private constructor() : Number(), Comparable<Byte> {
@SinceKotlin("1.1")
public operator fun rem(other: Double): Double
/** Increments this value. */
/**
* Returns this value incremented by one.
*
* @sample samples.misc.Builtins.inc
*/
public operator fun inc(): Byte
/** Decrements this value. */
/**
* Returns this value decremented by one.
*
* @sample samples.misc.Builtins.dec
*/
public operator fun dec(): Byte
/** Returns this value. */
public operator fun unaryPlus(): Int
/** Returns the negative of this value. */
@@ -411,10 +421,20 @@ public class Short private constructor() : Number(), Comparable<Short> {
@SinceKotlin("1.1")
public operator fun rem(other: Double): Double
/** Increments this value. */
/**
* Returns this value incremented by one.
*
* @sample samples.misc.Builtins.inc
*/
public operator fun inc(): Short
/** Decrements this value. */
/**
* Returns this value decremented by one.
*
* @sample samples.misc.Builtins.dec
*/
public operator fun dec(): Short
/** Returns this value. */
public operator fun unaryPlus(): Int
/** Returns the negative of this value. */
@@ -647,10 +667,20 @@ public class Int private constructor() : Number(), Comparable<Int> {
@SinceKotlin("1.1")
public operator fun rem(other: Double): Double
/** Increments this value. */
/**
* Returns this value incremented by one.
*
* @sample samples.misc.Builtins.inc
*/
public operator fun inc(): Int
/** Decrements this value. */
/**
* Returns this value decremented by one.
*
* @sample samples.misc.Builtins.dec
*/
public operator fun dec(): Int
/** Returns this value. */
public operator fun unaryPlus(): Int
/** Returns the negative of this value. */
@@ -918,10 +948,20 @@ public class Long private constructor() : Number(), Comparable<Long> {
@SinceKotlin("1.1")
public operator fun rem(other: Double): Double
/** Increments this value. */
/**
* Returns this value incremented by one.
*
* @sample samples.misc.Builtins.inc
*/
public operator fun inc(): Long
/** Decrements this value. */
/**
* Returns this value decremented by one.
*
* @sample samples.misc.Builtins.dec
*/
public operator fun dec(): Long
/** Returns this value. */
public operator fun unaryPlus(): Long
/** Returns the negative of this value. */
@@ -1208,10 +1248,20 @@ public class Float private constructor() : Number(), Comparable<Float> {
@SinceKotlin("1.1")
public operator fun rem(other: Double): Double
/** Increments this value. */
/**
* Returns this value incremented by one.
*
* @sample samples.misc.Builtins.inc
*/
public operator fun inc(): Float
/** Decrements this value. */
/**
* Returns this value decremented by one.
*
* @sample samples.misc.Builtins.dec
*/
public operator fun dec(): Float
/** Returns this value. */
public operator fun unaryPlus(): Float
/** Returns the negative of this value. */
@@ -1449,10 +1499,20 @@ public class Double private constructor() : Number(), Comparable<Double> {
@SinceKotlin("1.1")
public operator fun rem(other: Double): Double
/** Increments this value. */
/**
* Returns this value incremented by one.
*
* @sample samples.misc.Builtins.inc
*/
public operator fun inc(): Double
/** Decrements this value. */
/**
* Returns this value decremented by one.
*
* @sample samples.misc.Builtins.dec
*/
public operator fun dec(): Double
/** Returns this value. */
public operator fun unaryPlus(): Double
/** Returns the negative of this value. */