Add javadoc for retrieveCurrentTransforms

openjdk · Aug 18, 2020 · 16ea4d3 · 16ea4d3
1 parent c8ea20e
commit 16ea4d3
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/agent/src/main/java/org/openjdk/jmc/agent/jmx/AgentControllerMXBean.java b/agent/src/main/java/org/openjdk/jmc/agent/jmx/AgentControllerMXBean.java
@@ -38,6 +38,11 @@ public interface AgentControllerMXBean {
 
 	public void defineEventProbes(String xmlDescription) throws Exception;
 
+	/**
+	 * Returns the most recent XML configuration that was successfully applied.
+	 *
+	 * @return an XML snippet of the current configuration.
+	 */
 	public String retrieveEventProbes();
 
 	public JFRTransformDescriptor[] retrieveCurrentTransforms();