Add important note to Service API methods

ctrueden · ctrueden · commit 9dddf5fe02c8 · 2013-07-12T13:21:19.000-05:00
The two Service API methods, initialize() and registerEventHandlers(),
are not intended to be called by downstream code! Rather, the service
framework itself calls these methods to initialize the service.
diff --git a/src/main/java/org/scijava/service/Service.java b/src/main/java/org/scijava/service/Service.java
@@ -58,10 +58,24 @@ public interface Service extends SciJavaPlugin, Contextual, Prioritized,
 	Disposable
 {
 
-	/** Performs any needed initialization when the service is first loaded. */
+	/**
+	 * Performs any needed initialization when the service is first loaded.
+	 * <p>
+	 * NB: This method is not intended to be called directly. It is called by
+	 * the service framework itself (specifically by the {@link ServiceHelper})
+	 * when initializing the service. It should not be called a second time.
+	 * </p>
+	 */
 	void initialize();
 
-	/** Registers the service's event handler methods. */
+	/**
+	 * Registers the service's event handler methods.
+	 * <p>
+	 * NB: This method is not intended to be called directly. It is called by
+	 * the service framework itself (specifically by the {@link ServiceHelper})
+	 * when initializing the service. It should not be called a second time.
+	 * </p>
+	 */
 	void registerEventHandlers();
 
 }
