Skip to content

Fix APContextWriter generating bad Javadoc #132

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Nov 3, 2025
Merged

Fix APContextWriter generating bad Javadoc #132

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
daabfeb
Fix `APContextWriter` generating bad Javadoc
mechite Oct 29, 2025
bfea1db
Fix typo/grammar, "Utility" in `APContext`
mechite Oct 29, 2025
186bcff
Merge branch 'main' into main
SentryMan Nov 3, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions prism-core/src/main/java/io/avaje/prism/internal/APContextWriter.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ public static void write(PrintWriter out, String packageName, boolean moduleRead
+ compilerImports()
+ "\n"
+ "/**\n"
+ " * Utiliy Class that stores the {@link ProcessingEnvironment} and provides various helper methods\n"
+ " * Utility class that stores the {@link ProcessingEnvironment} and provides various helper methods.\n"
+ " */\n"
+ "@Generated(\"avaje-prism-generator\")\n"
+ "public final class APContext {\n"
Expand Down Expand Up @@ -210,8 +210,9 @@ public static void write(PrintWriter out, String packageName, boolean moduleRead
+ " }\n"
+ "\n"
+ " /**\n"
+ " * Prints a note.\n"
+ " * Prints a note at the location of the element.\n"
+ " *\n"
+ " * @param e the element to use as a position hint\n"
+ " * @param msg the message, or an empty string if none\n"
+ " * @param args {@code String#format} arguments\n"
+ " */\n"
Expand All @@ -220,9 +221,8 @@ public static void write(PrintWriter out, String packageName, boolean moduleRead
+ " }\n"
+ "\n"
+ " /**\n"
+ " * Prints a note at the location of the element.\n"
+ " * Prints a note.\n"
+ " *\n"
+ " * @param e the element to use as a position hint\n"
+ " * @param msg the message, or an empty string if none\n"
+ " * @param args {@code String#format} arguments\n"
+ " */\n"
Expand Down Expand Up @@ -332,7 +332,7 @@ public static void write(PrintWriter out, String packageName, boolean moduleRead
+ " *\n"
+ " * @param key the key of the processor option\n"
+ " * @return an Optional for the processor option, or null if none is available.\n"
+ " * @see {@link ProcessingEnvironment#getOptions()}\n"
+ " * @see ProcessingEnvironment#getOptions()\n"
+ " */\n"
+ " public static Optional<String> getOption(String key) {\n"
+ " return Optional.ofNullable(processingEnv().getOptions().get(key));\n"
Expand Down