From fc1ee1be21e27836dd613da701dc825347fcdd9f Mon Sep 17 00:00:00 2001
From: greg <greg.h@vidarrcap.com>
Date: Wed, 24 Jul 2024 11:09:19 +0100
Subject: [PATCH] javadoc

---
 .../serviceimport/ImportService.java          | 12 +++++++++
 .../serviceimport/ServiceCallback.java        | 25 ++++++++++++++++++-
 2 files changed, 36 insertions(+), 1 deletion(-)

diff --git a/reference-examples/runtime-execution/src/main/java/com/fluxtion/example/reference/serviceimport/ImportService.java b/reference-examples/runtime-execution/src/main/java/com/fluxtion/example/reference/serviceimport/ImportService.java
index 61d1ba1..9a74264 100644
--- a/reference-examples/runtime-execution/src/main/java/com/fluxtion/example/reference/serviceimport/ImportService.java
+++ b/reference-examples/runtime-execution/src/main/java/com/fluxtion/example/reference/serviceimport/ImportService.java
@@ -8,6 +8,18 @@
 
 import java.util.concurrent.atomic.AtomicLong;
 
+/**
+ * Imports a TimeService into the event processor, any node method annotated with {@code @ServiceRegistered} will receive
+ * the service if the types match.
+ *
+ * running the example:
+ *
+ * <pre>
+ *
+ *  started at 100
+ *  stopped at 500 elapsed:400
+ * </pre>
+ */
 public class ImportService {
 
     public static void main(String[] args) {
diff --git a/reference-examples/runtime-execution/src/main/java/com/fluxtion/example/reference/serviceimport/ServiceCallback.java b/reference-examples/runtime-execution/src/main/java/com/fluxtion/example/reference/serviceimport/ServiceCallback.java
index c95b546..828d1ee 100644
--- a/reference-examples/runtime-execution/src/main/java/com/fluxtion/example/reference/serviceimport/ServiceCallback.java
+++ b/reference-examples/runtime-execution/src/main/java/com/fluxtion/example/reference/serviceimport/ServiceCallback.java
@@ -9,7 +9,30 @@
 
 import java.util.concurrent.atomic.AtomicReference;
 
-
+/**
+ * Registers a callback listener method with an externally imported service.
+ *
+ * <ul>
+ *     <li>Register a MarketDataPublisher service with the event processor that registers MarketDataSubscriber</li>
+ *     <li>Create a MarketDataSubscriberNode that implements and exports the listener call back interface, MarketDataSubscriber</li>
+ *     <li>Annotate a node method with {@code @ServiceRegistered} to access the external MarketDataPublisher service</li>
+ *     <li>Register the subscription callback with the MarketDataPublisher using the EventProcessor.exportedService</li>
+ * </ul>
+ *
+ * The event processor implements the exported listener interface, MarketDataSubscriber, and receives the market
+ * data update callbacks. The processor dispatches and market updates to the MarketDataSubscriberNode or any other node
+ * that exports the MarketDataSubscriber interface.
+ *
+ *
+ * <pre>
+ *
+ * running the example:
+ *
+ * marketUpdate: AAA 23.24
+ * marketUpdate: AAA 19.99
+ * marketUpdate: AAA 15.67
+ * </pre>
+ */
 public class ServiceCallback {
 
     public static void main(String[] args) {