Skip to content

Commit

Permalink
Add JavaDoc comments to Rotation interface
Browse files Browse the repository at this point in the history
Added JavaDoc descriptions for the `pitch()` and `yaw()` methods, as well as the interface itself. This improves code readability and provides clear documentation for developers.
  • Loading branch information
NonSwag committed Feb 11, 2025
1 parent afb2d86 commit 291437d
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions paper-api/src/main/java/io/papermc/paper/math/Rotation.java
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,22 @@

import org.jspecify.annotations.NullMarked;

/**
* Represents a rotation with specified pitch and yaw values.
*/
@NullMarked
public interface Rotation {
/**
* Retrieves the pitch component of the rotation, measured in degrees.
*
* @return the pitch value in degrees
*/
float pitch();

/**
* Retrieves the yaw component of the rotation, measured in degrees.
*
* @return the yaw value in degrees
*/
float yaw();
}

0 comments on commit 291437d

Please sign in to comment.