Skip to content
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

feat: use JavaDoc as comments #2481

Merged
merged 1 commit into from
Aug 23, 2024
Merged

Conversation

stuartwdouglas
Copy link
Collaborator

This is a very basic PoC implementation that can serve as a base for further work.

@stuartwdouglas stuartwdouglas requested review from a team and matt2e and removed request for a team August 22, 2024 22:28
@ftl-robot ftl-robot mentioned this pull request Aug 22, 2024
This is a very basic PoC implementation that can serve as a base for further work.

fixes: 2417
@stuartwdouglas stuartwdouglas force-pushed the stuartwdouglas/java-annotations branch from b33fcd8 to 2ef070e Compare August 22, 2024 22:30
@stuartwdouglas stuartwdouglas added this pull request to the merge queue Aug 23, 2024
Merged via the queue into main with commit cafa316 Aug 23, 2024
19 checks passed
@stuartwdouglas stuartwdouglas deleted the stuartwdouglas/java-annotations branch August 23, 2024 00:13
@@ -82,9 +82,11 @@ public class ModuleBuilder {
private final Map<DotName, TopicsBuildItem.DiscoveredTopic> knownTopics;
private final Map<DotName, VerbClientBuildItem.DiscoveredClients> verbClients;
private final FTLRecorder recorder;
private final Map<String, String> verbDocs;
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just to make sure you know, most declarations in the FTL schema can include comments - data structures, enums, etc.

/**
* POC annotation processor for capturing JavaDoc, this needs a lot more work.
*/
public class AnnotationProcessor implements Processor {
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Does this run as part of the module JVM instance, or as part of the build?

@alecthomas
Copy link
Collaborator

This is awesome.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants