-
Notifications
You must be signed in to change notification settings - Fork 18
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.
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
Add annotation processor to generate documentation #102
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ppkarwasz
force-pushed
the
processor
branch
4 times, most recently
from
February 8, 2024 12:54
dde15eb
to
4cbbfbd
Compare
vy
approved these changes
Feb 8, 2024
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Dropped some remarks, but overall it LGTM.
log4j-docgen/src/main/java/org/apache/logging/log4j/docgen/processor/DocGenProcessor.java
Outdated
Show resolved
Hide resolved
log4j-docgen/src/main/java/org/apache/logging/log4j/docgen/processor/DocGenProcessor.java
Outdated
Show resolved
Hide resolved
log4j-docgen/src/main/java/org/apache/logging/log4j/docgen/processor/DocGenProcessor.java
Outdated
Show resolved
Hide resolved
log4j-docgen/src/main/java/org/apache/logging/log4j/docgen/processor/DocGenProcessor.java
Outdated
Show resolved
Hide resolved
log4j-docgen/src/main/java/org/apache/logging/log4j/docgen/processor/DocGenProcessor.java
Show resolved
Hide resolved
log4j-docgen/src/test/java/org/apache/logging/log4j/docgen/processor/DocGenProcessorTest.java
Show resolved
Hide resolved
log4j-docgen/src/test/java/org/apache/logging/log4j/docgen/processor/DocGenProcessorTest.java
Show resolved
Hide resolved
We add a documentation-generating annotation processor. By default it generates a `plugins.xml` descriptor in the `META-INF/log4j` directory of the output folder. Currently it supports: * Log4j Plugins 3.x annotations **only**, * Both factory methods and builders. Closes apache/logging-log4j2#1956.
By using `AnnotationMirror` instead of the annotation classes directly, we can lower down the Java requirements to Java 8.
I have:
|
We add a separate equivalent test for 2.x annotations.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This draft PR is based on #101.
We add a documentation-generating annotation processor.
By default it generates a
plugins.xml
descriptor in theMETA-INF/log4j
directory of the output folder.Currently it supports:
Closes apache/logging-log4j2#1956.