[#93] comment

emustudio · Jan 2, 2024 · 05a2e1d · 05a2e1d
1 parent 6fc7532
commit 05a2e1d
Showing 1 changed file with 9 additions and 0 deletions.
diff --git a/src/main/java/net/emustudio/emulib/plugins/cpu/AccurateFrequencyRunner.java b/src/main/java/net/emustudio/emulib/plugins/cpu/AccurateFrequencyRunner.java
@@ -102,6 +102,15 @@ public CPU.RunState run(Supplier<Double> getTargetFrequencyKHz, Supplier<CPU.Run
         return currentRunState;
     }
 
+    /**
+     * Runs the CPU without "sleeping".
+     * <p>
+     * The "runInstruction" function must call {@link #addExecutedCycles(long)} to update executed cycles.
+     *
+     * @param getTargetFrequencyKHz get target frequency in kHz
+     * @param runInstruction        runs one instruction
+     * @return new run state
+     */
     public CPU.RunState runNoSleep(Supplier<Double> getTargetFrequencyKHz, Supplier<CPU.RunState> runInstruction) {
         double oneCycleTimeNanos = 1000000.0 / getTargetFrequencyKHz.get();