Skip to content

Commit 3443df9

Browse files
committed
cleanup: Fix the ktlint errors requiring manual intervention
This fixes the warnings: * an EOL comment may not be preceded by a KDoc * Property name should use the screaming snake case notation when the value can not be changed
1 parent 7f72150 commit 3443df9

File tree

11 files changed

+91
-87
lines changed

11 files changed

+91
-87
lines changed

lib/src/main/java/im/tox/tox4j/av/ToxAv.kt

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -34,8 +34,8 @@ interface ToxAv : Closeable {
3434
*
3535
* @param tox A compatible ToxCore implementation.
3636
* @return the new A/V session.
37+
* @throws ToxavNewException
3738
*/
38-
// @throws[ToxavNewException]
3939
fun create(tox: ToxCore): ToxAv
4040

4141
/**
@@ -69,8 +69,8 @@ interface ToxAv : Closeable {
6969
* @param friendNumber The friend number of the friend that should be called.
7070
* @param audioBitRate Audio bit rate in Kb/sec. Set this to 0 to disable audio sending.
7171
* @param videoBitRate Video bit rate in Kb/sec. Set this to 0 to disable video sending.
72+
* @throws ToxavCallException
7273
*/
73-
// @throws[ToxavCallException]
7474
fun call(
7575
friendNumber: ToxFriendNumber,
7676
audioBitRate: BitRate,
@@ -86,8 +86,8 @@ interface ToxAv : Closeable {
8686
* @param friendNumber The friend number of the friend that is calling.
8787
* @param audioBitRate Audio bit rate in Kb/sec. Set this to 0 to disable audio sending.
8888
* @param videoBitRate Video bit rate in Kb/sec. Set this to 0 to disable video sending.
89+
* @throws ToxavAnswerException
8990
*/
90-
// @throws[ToxavAnswerException]
9191
fun answer(
9292
friendNumber: ToxFriendNumber,
9393
audioBitRate: BitRate,
@@ -99,8 +99,8 @@ interface ToxAv : Closeable {
9999
*
100100
* @param friendNumber The friend number of the friend to send the call control to.
101101
* @param control The control command to send.
102+
* @throws ToxavCallControlException
102103
*/
103-
// @throws[ToxavCallControlException]
104104
fun callControl(
105105
friendNumber: ToxFriendNumber,
106106
control: ToxavCallControl,
@@ -112,8 +112,8 @@ interface ToxAv : Closeable {
112112
* @param friendNumber The friend number of the friend for which to set the audio bit rate.
113113
* @param audioBitRate The new audio bit rate in Kb/sec. Set to 0 to disable audio sending. Pass
114114
* -1 to leave unchanged.
115+
* @throws ToxavBitRateSetException
115116
*/
116-
// @throws[ToxavBitRateSetException]
117117
fun setAudioBitRate(
118118
friendNumber: ToxFriendNumber,
119119
audioBitRate: BitRate,
@@ -125,8 +125,8 @@ interface ToxAv : Closeable {
125125
* @param friendNumber The friend number of the friend for which to set the audio bit rate.
126126
* @param videoBitRate The new video bit rate in Kb/sec. Set to 0 to disable video sending. Pass
127127
* -1 to leave unchanged.
128+
* @throws ToxavBitRateSetException
128129
*/
129-
// @throws[ToxavBitRateSetException]
130130
fun setVideoBitRate(
131131
friendNumber: ToxFriendNumber,
132132
videoBitRate: BitRate,
@@ -148,8 +148,8 @@ interface ToxAv : Closeable {
148148
* @param channels Number of audio channels. Supported values are 1 and 2.
149149
* @param samplingRate Audio sampling rate used in this frame in Hz. Valid sampling rates are
150150
* 8000, 12000, 16000, 24000, or 48000.
151+
* @throws ToxavSendFrameException
151152
*/
152-
// @throws[ToxavSendFrameException]
153153
fun audioSendFrame(
154154
friendNumber: ToxFriendNumber,
155155
pcm: ShortArray,
@@ -170,8 +170,8 @@ interface ToxAv : Closeable {
170170
* @param y Y (Luminance) plane data.
171171
* @param u U (Chroma) plane data.
172172
* @param v V (Chroma) plane data.
173+
* @throws ToxavSendFrameException
173174
*/
174-
// @throws[ToxavSendFrameException]
175175
fun videoSendFrame(
176176
friendNumber: ToxFriendNumber,
177177
width: Int,

lib/src/main/java/im/tox/tox4j/av/data/AudioLength.kt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
package im.tox.tox4j.av.data
22

33
/** Length in microseconds. */
4+
@Suppress("ktlint:standard:enum-entry-name-case")
45
enum class AudioLength(val value: Int) {
56
Length2_5(2500),
67
Length5(5000),

0 commit comments

Comments
 (0)