Skip to content

Commit 8a9db93

Browse files
author
Bram Ceulemans
committed
Add JavaDoc to Profiler API
1 parent 8a7b0b8 commit 8a9db93

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed
Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,23 @@
11
package me.lucko.spark.api.profiler;
22

3+
import org.jetbrains.annotations.Nullable;
4+
35
public interface Profiler {
46

7+
/**
8+
* Start the Spark Profiler using a profiler configuration.
9+
* A configuration can be built using {@link ProfilerConfiguration#builder()}.
10+
*
11+
* @param configuration the configuration object
12+
* @return if the profiler started successfully
13+
*/
514
boolean start(ProfilerConfiguration configuration);
615

16+
/**
17+
* Stop the currently running profiler.
18+
*
19+
* @return the profiler report or null if no profiler was running.
20+
*/
21+
@Nullable
722
ProfilerReport stop();
823
}

0 commit comments

Comments
 (0)