Skip to content

Commit

Permalink
Fix package for ExampleExpectPlatform
Browse files Browse the repository at this point in the history
  • Loading branch information
shedaniel committed Nov 28, 2021
1 parent 7d8a11c commit d885fca
Showing 1 changed file with 4 additions and 2 deletions.
Original file line number Diff line number Diff line change
@@ -1,21 +1,23 @@
package net.examplemod;

import dev.architectury.injectables.annotations.ExpectPlatform;
import dev.architectury.platform.Platform;
import @ARCHITECTURY_PACKAGE@.platform.Platform;

import java.nio.file.Path;

public class ExampleExpectPlatform {
/**
* We can use {@link Platform#getConfigFolder()} but this is just an example of {@link ExpectPlatform}.
* <p>
* This must be a public static method. The platform-implemented solution must be placed under a
* This must be a <b>public static</b> method. The platform-implemented solution must be placed under a
* platform sub-package, with its class suffixed with {@code Impl}.
* <p>
* Example:
* Expect: net.examplemod.ExampleExpectPlatform#getConfigDirectory()
* Actual Fabric: net.examplemod.fabric.ExampleExpectPlatformImpl#getConfigDirectory()
* Actual Forge: net.examplemod.forge.ExampleExpectPlatformImpl#getConfigDirectory()
* <p>
* <a href="https://plugins.jetbrains.com/plugin/16210-architectury">You should also get the IntelliJ plugin to help with @ExpectPlatform.</a>
*/
@ExpectPlatform
public static Path getConfigDirectory() {
Expand Down

0 comments on commit d885fca

Please sign in to comment.