Some javadoc improvements #5114

Kilip1000 · 2025-12-31T22:11:50Z

No description provided.

...rce-loader-v0/src/main/java/net/fabricmc/fabric/api/resource/ResourcePackActivationType.java

fabric-api-base/src/main/java/net/fabricmc/fabric/api/event/Event.java

fabric-api-base/src/main/java/net/fabricmc/fabric/api/util/TriState.java

...ic-biome-api-v1/src/main/java/net/fabricmc/fabric/api/biome/v1/BiomeModificationContext.java

...pi-v1/src/testmod/java/net/fabricmc/fabric/test/screenhandler/item/ImplementedInventory.java

fabric-item-api-v1/src/main/java/net/fabricmc/fabric/api/item/v1/FabricItem.java

...v1/src/main/java/net/fabricmc/fabric/api/transfer/v1/fluid/FluidVariantAttributeHandler.java

Kilip1000 · 2026-01-01T00:36:30Z

Yeah, for some reason I can't put paragraphs because of checkstyle demanding the previous line to be empty, but if it is, it doesn't pick up on it

sylv256 · 2026-01-01T00:47:55Z

Yeah, for some reason I can't put paragraphs because of checkstyle demanding the previous line to be empty, but if it is, it doesn't pick up on it

Did you remove the space on the previous line?

Kilip1000 · 2026-01-01T00:50:02Z

Yeah, for some reason I can't put paragraphs because of checkstyle demanding the previous line to be empty, but if it is, it doesn't pick up on it

Did you remove the space on the previous line?

I did, yes, I even Ctrl F-ed it to make sure

Kilip1000 · 2026-01-01T08:51:54Z

Ah, yes status code 403 from server: Forbidden

fabric-biome-api-v1/src/main/java/net/fabricmc/fabric/api/biome/v1/BiomeSelectionContext.java

fabric-item-api-v1/src/main/java/net/fabricmc/fabric/api/item/v1/FabricItem.java

ekulxam · 2026-01-06T02:06:24Z

...-renderer-api-v1/src/client/java/net/fabricmc/fabric/api/renderer/v1/mesh/QuadTransform.java

-	 * Return false to filter out quads from rendering. When more than one transform
-	 * is in effect, returning false means unapplied transforms will not receive the quad.
+	 * Return {@code false} to filter out quads from rendering. When more than one transform
+	 * is in effect, returning {@code false} means unapplied transforms will not receive the quad.


Is @return not applicable in interface methods?

ekulxam · 2026-01-06T02:08:44Z

...pi-v1/src/testmod/java/net/fabricmc/fabric/test/screenhandler/item/ImplementedInventory.java

 	 * @param slot  the slot
 	 * @param count the item count
-	 * @return a stack
+	 * @return the removed stack with count {@code count} or {@link ItemStack#EMPTY} if query is invalid


Do we need to define what qualifies as an invalid query?

ekulxam · 2026-01-06T02:09:57Z

fabric-transfer-api-v1/src/main/java/net/fabricmc/fabric/api/transfer/v1/storage/Storage.java


 	/**
-	 * Return false if calling {@link #extract} will absolutely always return 0, or true otherwise or in doubt.
+	 * Return {@code false} if calling {@link #extract} will absolutely always return 0, or {@code true} otherwise or in doubt.


ekulxam · 2026-01-06T02:13:43Z

fabric-transfer-api-v1/src/main/java/net/fabricmc/fabric/api/transfer/v1/storage/Storage.java


 	/**
-	 * Return false if calling {@link #insert} will absolutely always return 0, or true otherwise or in doubt.
+	 * Return {@code false} if calling {@link #insert} will absolutely always return 0, or {@code true} otherwise or in doubt.


Suggested change

* Return {@code false} if calling {@link #insert} will absolutely always return 0, or {@code true} otherwise or in doubt.

* @return {@code false} if calling {@link #insert} will absolutely always return 0, or {@code true} otherwise or in doubt.

ekulxam · 2026-01-06T02:14:26Z

fabric-api-base/src/main/java/net/fabricmc/fabric/api/event/Event.java

 	 * Returns the invoker instance.
 	 *
 	 * <p>An "invoker" is an object which hides multiple registered
-	 * listeners of type T under one instance of type T, executing
+	 * listeners of type {@code T} under one instance of type {@code T}, executing
 	 * them and leaving early as necessary.
-	 *
-	 * @return The invoker instance.


IMO keep the @return and remove the above statement that says "Returns the invoker instance."

ekulxam · 2026-01-06T02:14:41Z

fabric-biome-api-v1/src/main/java/net/fabricmc/fabric/api/biome/v1/BiomeSelectionContext.java


 	/**
-	 * Returns true if this biome contains a placed feature referencing a configured feature with the given key.
+	 * Returns {@code true} if this biome contains a placed feature referencing a configured feature with the given key.


Suggested change

* Returns {@code true} if this biome contains a placed feature referencing a configured feature with the given key.

* @return {@code true} if this biome contains a placed feature referencing a configured feature with the given key.

ekulxam · 2026-01-06T02:14:55Z

fabric-biome-api-v1/src/main/java/net/fabricmc/fabric/api/biome/v1/BiomeSelectionContext.java

-
 	/**
-	 * Returns true if the configured structure with the given key can start in this biome in any chunk generator
+	 * Returns {@code true} if the configured structure with the given key can start in this biome in any chunk generator


Suggested change

* Returns {@code true} if the configured structure with the given key can start in this biome in any chunk generator

* @return {@code true} if the configured structure with the given key can start in this biome in any chunk generator

ekulxam · 2026-01-06T02:15:05Z

fabric-biome-api-v1/src/main/java/net/fabricmc/fabric/api/biome/v1/NetherBiomes.java


 	/**
-	 * Returns true if the given biome can generate in the nether, considering the Vanilla nether biomes,
+	 * Returns {@code true} if the given biome can generate in the nether, considering the Vanilla nether biomes,


Suggested change

* Returns {@code true} if the given biome can generate in the nether, considering the Vanilla nether biomes,

* @return {@code true} if the given biome can generate in the nether, considering the Vanilla nether biomes,

No changes to return javadoc though.

Kilip1000 · 2026-01-06T08:00:11Z

Also, to all of the feedback relating to returns, I'd like to keep this minimal, not focusing on returns at all.

Kilip1000 added 11 commits December 31, 2025 22:02

Some @reurns and {@code true}

7037ad5

fix

534df53

Fix some returns

15c3379

finished the true refactors

cf45e2a

finished the false refactors

64a0b61

returns

6a417c7

fix

9ee5a5c

fix

e9542b6

fix?

68f5cba

fix

9a704d5

fix

b161448

Juuxel suggested changes Jan 1, 2026

View reviewed changes

fix

da84b16

weirdness

a2b1390

Kilip1000 added 4 commits January 1, 2026 01:57

more fixes

2677bd0

Less changes to return

e90c519

some more undos

69832ef

last of the undos

0e64ada

Kilip1000 marked this pull request as draft January 1, 2026 01:59

.

34e65ab

Kilip1000 marked this pull request as ready for review January 1, 2026 06:31

Merge branch 'FabricMC:1.21.11' into 1.21.11

5db8f28

ekulxam suggested changes Jan 6, 2026

View reviewed changes

Kilip1000 added 2 commits January 6, 2026 08:43

A bunch of changes to accommodate feedback

362d61d

No changes to return javadoc though.

tests?

5ca4d47

Kilip1000 added 2 commits January 6, 2026 09:05

better description

0518084

fix

c971aae

	* Return {@code false} if calling {@link #insert} will absolutely always return 0, or {@code true} otherwise or in doubt.
	* @return {@code false} if calling {@link #insert} will absolutely always return 0, or {@code true} otherwise or in doubt.

	* Returns {@code true} if this biome contains a placed feature referencing a configured feature with the given key.
	* @return {@code true} if this biome contains a placed feature referencing a configured feature with the given key.

	* Returns {@code true} if the configured structure with the given key can start in this biome in any chunk generator
	* @return {@code true} if the configured structure with the given key can start in this biome in any chunk generator

	* Returns {@code true} if the given biome can generate in the nether, considering the Vanilla nether biomes,
	* @return {@code true} if the given biome can generate in the nether, considering the Vanilla nether biomes,

Some javadoc improvements #5114

Are you sure you want to change the base?

Some javadoc improvements #5114

Conversation

Kilip1000 commented Dec 31, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Kilip1000 commented Jan 1, 2026

Uh oh!

sylv256 commented Jan 1, 2026

Uh oh!

Kilip1000 commented Jan 1, 2026

Uh oh!

Kilip1000 commented Jan 1, 2026

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Kilip1000 commented Jan 6, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants