Skip to content

Commit cdf2473

Browse files
committed
normalize javadocs
1 parent 9e649ff commit cdf2473

File tree

300 files changed

+970
-982
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

300 files changed

+970
-982
lines changed

data/com/mojang/blaze3d/audio/Library.mapping

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ CLASS com/mojang/blaze3d/audio/Library
88
ARG 1 memoryStack
99
ARG 2 enableHrtf
1010
METHOD getAvailableSoundDevices ()Ljava/util/List;
11-
COMMENT {@return A list of strings representing the names of available sound devices, or an empty list if no devices are available}
11+
COMMENT {@return a list of strings representing the names of available sound devices, or an empty list if no devices are available}
1212
METHOD getChannelCount ()I
1313
COMMENT {@return the number of channels available for audio playback}
1414
METHOD getCurrentDeviceName ()Ljava/lang/String;
@@ -22,27 +22,27 @@ CLASS com/mojang/blaze3d/audio/Library
2222
COMMENT @return {@code true} if the default device has changed since the last time this method was called, {@code false} otherwise
2323
METHOD init (Ljava/lang/String;Z)V
2424
COMMENT Initializes the OpenAL device and context.
25-
COMMENT @throws IllegalStateException if an error occurs during initialization.
25+
COMMENT @throws IllegalStateException if an error occurs during initialization
2626
ARG 1 deviceSpecifier
27-
COMMENT A string specifying the name of the audio device to use, or {@code null} to use the default device.
27+
COMMENT a string specifying the name of the audio device to use, or {@code null} to use the default device
2828
ARG 2 enableHrtf
29-
COMMENT Whether to enable HRTF (head-related transfer function) for spatial audio.
29+
COMMENT whether to enable HRTF (head-related transfer function) for spatial audio
3030
METHOD openDeviceOrFallback (Ljava/lang/String;)J
3131
COMMENT Opens the specified audio device, or the default device if the specifier is {@code null}.
32-
COMMENT @return The handle of the opened device.
33-
COMMENT @throws IllegalStateException if the device cannot be opened.
32+
COMMENT @return the handle of the opened device
33+
COMMENT @throws IllegalStateException if the device cannot be opened
3434
ARG 0 deviceSpecifier
35-
COMMENT The name of the audio device to open, or {@code null} to open the default device.
35+
COMMENT the name of the audio device to open, or {@code null} to open the default device
3636
METHOD releaseChannel (Lcom/mojang/blaze3d/audio/Channel;)V
3737
COMMENT Releases a channel.
3838
COMMENT @return whether the channel was successfully released
3939
ARG 1 channel
40-
COMMENT The channel to release.
40+
COMMENT the channel to release
4141
METHOD tryOpenDevice (Ljava/lang/String;)Ljava/util/OptionalLong;
4242
COMMENT Attempts to open the specified audio device.
43-
COMMENT @return an {@linkplain OptionalLong} containing the handle of the opened device if successful, or empty if the device could not be opened
43+
COMMENT @return an {@link OptionalLong} containing the handle of the opened device if successful, or empty if the device could not be opened
4444
ARG 0 deviceSpecifier
45-
COMMENT A string specifying the name of the audio device to open, or {@code null} to use the default device.
45+
COMMENT a string specifying the name of the audio device to open, or {@code null} to use the default device
4646
CLASS ChannelPool
4747
METHOD release (Lcom/mojang/blaze3d/audio/Channel;)Z
4848
ARG 1 channel

data/com/mojang/blaze3d/audio/OpenAlUtil.mapping

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -2,29 +2,29 @@ CLASS com/mojang/blaze3d/audio/OpenAlUtil
22
COMMENT The OpenALUtil class provides utility functions for working with OpenAL audio.
33
METHOD alErrorToString (I)Ljava/lang/String;
44
COMMENT Converts an OpenAL error code to a human-readable error message.
5-
COMMENT @return A String representing the error message for the given error code.
5+
COMMENT @return a String representing the error message for the given error code
66
ARG 0 errorCode
7-
COMMENT The OpenAL error code to convert
7+
COMMENT the OpenAL error code to convert
88
METHOD alcErrorToString (I)Ljava/lang/String;
99
COMMENT Converts an ALC error code to a human-readable error message.
10-
COMMENT @return A String representing the error message for the given error code.
10+
COMMENT @return a String representing the error message for the given error code
1111
ARG 0 errorCode
12-
COMMENT The ALC error code to convert
12+
COMMENT the ALC error code to convert
1313
METHOD audioFormatToOpenAl (Ljavax/sound/sampled/AudioFormat;)I
1414
COMMENT Converts an AudioFormat object to the corresponding OpenAL audio format code.
15-
COMMENT @return An integer representing the corresponding OpenAL audio format code.
16-
COMMENT @throws IllegalArgumentException if the given AudioFormat is not a supported format.
15+
COMMENT @return an integer representing the corresponding OpenAL audio format code
16+
COMMENT @throws IllegalArgumentException if the given AudioFormat is not a supported format
1717
ARG 0 format
18-
COMMENT The AudioFormat object to convert
18+
COMMENT the AudioFormat object to convert
1919
METHOD checkALCError (JLjava/lang/String;)Z
2020
COMMENT Checks for an ALC error and logs an error message if one is found.
21-
COMMENT @return {@code true} if an ALC error was found, {@code false} otherwise.
21+
COMMENT @return {@code true} if an ALC error was found, {@code false} otherwise
2222
ARG 0 deviceHandle
23-
COMMENT The handle of the device to check for errors on
23+
COMMENT the handle of the device to check for errors on
2424
ARG 2 operationState
25-
COMMENT A String describing the operation being performed when the error occurred
25+
COMMENT a String describing the operation being performed when the error occurred
2626
METHOD checkALError (Ljava/lang/String;)Z
2727
COMMENT Checks for an OpenAL error and logs an error message if one is found.
28-
COMMENT @return {@code true} if an OpenAL error was found, {@code false} otherwise.
28+
COMMENT @return {@code true} if an OpenAL error was found, {@code false} otherwise
2929
ARG 0 operationState
30-
COMMENT A String describing the operation being performed when the error occurred
30+
COMMENT a String describing the operation being performed when the error occurred

data/com/mojang/blaze3d/audio/SoundBuffer.mapping

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,8 @@ CLASS com/mojang/blaze3d/audio/SoundBuffer
1111
COMMENT Returns an OptionalInt containing the OpenAL buffer handle for this SoundBuffer.
1212
COMMENT If the buffer has not been created yet, creates the buffer and returns the handle.
1313
COMMENT If the buffer cannot be created, returns an empty OptionalInt.
14-
COMMENT @return An OptionalInt containing the OpenAL buffer handle, or an empty OptionalInt if the buffer cannot be created.
14+
COMMENT @return an {@link OptionalInt} containing the OpenAL buffer handle, or an empty one, if the buffer cannot be created}
1515
METHOD releaseAlBuffer ()Ljava/util/OptionalInt;
1616
COMMENT Releases the OpenAL buffer associated with this SoundBuffer and returns it as an OptionalInt.
1717
COMMENT If no buffer has been created yet, returns an empty OptionalInt.
18-
COMMENT @return an {@linkplain OptionalInt} containing the OpenAL buffer handle, or an empty one, if the buffer has not been created
18+
COMMENT @return an {@link OptionalInt} containing the OpenAL buffer handle, or an empty one, if the buffer has not been created

data/com/mojang/realmsclient/client/FileDownload.mapping

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ CLASS com/mojang/realmsclient/client/FileDownload
1010
COMMENT Modifies a folder name to make sure it is valid to store on disk.
1111
COMMENT @return the modified folder name
1212
ARG 0 folderName
13-
COMMENT The folder name to modify
13+
COMMENT the folder name to modify
1414
METHOD untarGzipArchive (Ljava/lang/String;Ljava/io/File;Lnet/minecraft/world/level/storage/LevelStorageSource;)V
1515
ARG 1 worldName
1616
ARG 2 tempFile

data/com/mojang/realmsclient/client/FileUpload.mapping

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ CLASS com/mojang/realmsclient/client/FileUpload
1818
ARG 2 uploadResult
1919
METHOD requestUpload (I)Lcom/mojang/realmsclient/gui/screens/UploadResult;
2020
ARG 1 retries
21-
COMMENT The number of times this upload has already been attempted
21+
COMMENT the number of times this upload has already been attempted
2222
METHOD retryUploadAfter (JI)Lcom/mojang/realmsclient/gui/screens/UploadResult;
2323
ARG 1 seconds
2424
ARG 3 retries

data/net/minecraft/ChatFormatting.mapping

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ CLASS net/minecraft/ChatFormatting
2929
COMMENT Gets a value by its friendly name {@code null} if the given name does not map to a defined value.
3030
ARG 0 friendlyName
3131
METHOD getId ()I
32-
COMMENT Returns the numerical color index that represents this formatting
32+
COMMENT {@return the numerical color index that represents this formatting}
3333
METHOD getName ()Ljava/lang/String;
3434
COMMENT Gets the friendly name of this value.
3535
METHOD getNames (ZZ)Ljava/util/Collection;
@@ -39,9 +39,9 @@ CLASS net/minecraft/ChatFormatting
3939
METHOD isColor ()Z
4040
COMMENT Checks if this is a color code.
4141
METHOD isFormat ()Z
42-
COMMENT {@code false} if this is just changing the color or resetting {@code true} otherwise.
42+
COMMENT @return {@code false} if this is just changing the color or resetting {@code true} otherwise
4343
METHOD lambda$static$0 (Lnet/minecraft/ChatFormatting;)Ljava/lang/String;
4444
ARG 0 formatting
4545
METHOD stripFormatting (Ljava/lang/String;)Ljava/lang/String;
46-
COMMENT Returns a copy of the given string, with formatting codes stripped away.
46+
COMMENT {@return a copy of the given string, with formatting codes stripped away}
4747
ARG 0 text

data/net/minecraft/CrashReport.mapping

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ CLASS net/minecraft/CrashReport
1717
COMMENT Gets the various sections of the crash report into the given StringBuilder
1818
ARG 1 builder
1919
METHOD getException ()Ljava/lang/Throwable;
20-
COMMENT Returns the Throwable object that is the cause for the crash and Crash Report.
20+
COMMENT {@return the Throwable object that is the cause for the crash and crash report}
2121
METHOD getExceptionMessage ()Ljava/lang/String;
2222
COMMENT Gets the stack trace of the Throwable that caused this crash report, or if that fails, the cause {@code .toString()}.
2323
METHOD getFriendlyReport (Lnet/minecraft/ReportType;)Ljava/lang/String;
@@ -26,7 +26,7 @@ CLASS net/minecraft/CrashReport
2626
ARG 1 type
2727
ARG 2 links
2828
METHOD getTitle ()Ljava/lang/String;
29-
COMMENT Returns the description of the Crash Report.
29+
COMMENT {@return the description of the crash report}
3030
METHOD saveToFile (Ljava/nio/file/Path;Lnet/minecraft/ReportType;)Z
3131
ARG 1 path
3232
ARG 2 type

data/net/minecraft/CrashReportCategory.mapping

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,9 @@ CLASS net/minecraft/CrashReportCategory
22
METHOD <init> (Ljava/lang/String;)V
33
ARG 1 title
44
METHOD fillInStackTrace (I)I
5-
COMMENT Resets our stack trace according to the current trace, pruning the deepest 3 entries. The parameter indicates how many additional deepest entries to prune. Returns the number of entries in the resulting pruned stack trace.
5+
COMMENT Resets our stack trace according to the current trace, pruning the deepest 3 entries.
6+
COMMENT The parameter indicates how many additional deepest entries to prune.
7+
COMMENT @return the number of entries in the resulting pruned stack trace
68
ARG 1 size
79
METHOD formatLocation (DDD)Ljava/lang/String;
810
ARG 0 x

data/net/minecraft/SharedConstants.mapping

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,7 @@ CLASS net/minecraft/SharedConstants
9696
METHOD debugVoidTerrain (Lnet/minecraft/world/level/ChunkPos;)Z
9797
ARG 0 chunkPos
9898
METHOD getCurrentVersion ()Lnet/minecraft/WorldVersion;
99-
COMMENT @return the {@link WorldVersion world version}
99+
COMMENT @return the {@linkplain WorldVersion world version}
100100
COMMENT @throws IllegalStateException if a world version has not been set previously
101101
METHOD getProtocolVersion ()I
102102
COMMENT {@return the networking protocol version in use by this game version}

data/net/minecraft/Util.mapping

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -253,7 +253,8 @@ CLASS net/minecraft/Util
253253
ARG 0 fileName
254254
ARG 1 characterValidator
255255
METHOD sequence (Ljava/util/List;)Ljava/util/concurrent/CompletableFuture;
256-
COMMENT Takes a list of futures and returns a future of list that completes when all of them succeed or any of them error,
256+
COMMENT Takes a list of futures.
257+
COMMENT @return a future of list that completes when all of them succeed or any of them error
257258
ARG 0 futures
258259
METHOD sequenceFailFast (Ljava/util/List;)Ljava/util/concurrent/CompletableFuture;
259260
ARG 0 completableFutures

0 commit comments

Comments
 (0)