Browse Source

Add preformatted tags to Javadoc in OsProbe

This commit adds preformatted tags to the Javadoc for
OsProbe#readSysFsCgroupCpuAcctCpuStat to render the form of the cpu.stat
file in a fixed-width font.
Jason Tedor 9 years ago
parent
commit
b89c5aff51
1 changed files with 2 additions and 0 deletions
  1. 2 0
      core/src/main/java/org/elasticsearch/monitor/os/OsProbe.java

+ 2 - 0
core/src/main/java/org/elasticsearch/monitor/os/OsProbe.java

@@ -400,9 +400,11 @@ public class OsProbe {
      * {@code cpu} subsystem. These lines represent the CPU time
      * statistics and have the form
      * <p>
+     * <pre>
      * nr_periods \d+
      * nr_throttled \d+
      * throttled_time \d+
+     * </pre>
      * <p>
      * where {@code nr_periods} is the number of period intervals
      * as specified by {@code cpu.cfs_period_us} that have elapsed,