Add Javadoc and related settings

[lttng-ust-java-tests.git] / src / test / java / org / lttng / ust / agent / utils / MiscTestUtils.java

diff --git a/src/test/java/org/lttng/ust/agent/utils/MiscTestUtils.java b/src/test/java/org/lttng/ust/agent/utils/MiscTestUtils.java
index dd5505c7effb06f203b83110edbf21db739246e9..3aac32c00d1627641f9fa59dd7a6012e1d22d236 100644 (file)
--- a/src/test/java/org/lttng/ust/agent/utils/MiscTestUtils.java
+++ b/src/test/java/org/lttng/ust/agent/utils/MiscTestUtils.java
@@ -91,6 +91,12 @@ public final class MiscTestUtils {
         }
     }
 
+    /**
+     * Check if there is a user session daemon currently running on the system.
+     * It needs to be of the same user as the application running this program.
+     *
+     * @return If there is a user session daemon currently running
+     */
     public static boolean checkForUserSessiond() {
         String userName = System.getProperty("user.name");
 
@@ -104,6 +110,12 @@ public final class MiscTestUtils {
                 .anyMatch(s -> s.startsWith(shortUserName));
     }
 
+    /**
+     * Check if there is a root user session daemon daemon currently running on
+     * the system.
+     *
+     * @return If there is a root session daemon currently running
+     */
     public static boolean checkForRootSessiond() {
         List<String> command = Arrays.asList("ps", "-e", "u");
         List<String> output = getOutputFromCommand(false, command);