Skip to content

Commit 27fbd9e

Browse files
Fix "unexpected heading" Javadoc errors on Java 13+.
1 parent a315d69 commit 27fbd9e

5 files changed

Lines changed: 16 additions & 16 deletions

File tree

src/main/java/org/apache/commons/io/DirectoryWalker.java

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@
4646
* behaviour.</li>
4747
* </ul>
4848
*
49-
* <h3 id="example">1. Example Implementation</h3>
49+
* <h2 id="example">1. Example Implementation</h2>
5050
*
5151
* There are many possible extensions, for example, to delete all
5252
* files and '.svn' directories, and return a list of deleted files:
@@ -82,7 +82,7 @@
8282
* }
8383
* </pre>
8484
*
85-
* <h3 id="filter">2. Filter Example</h3>
85+
* <h2 id="filter">2. Filter Example</h2>
8686
*
8787
* <p>
8888
* Choosing which directories and files to process can be a key aspect
@@ -157,7 +157,7 @@
157157
* option for filtering.
158158
* </p>
159159
*
160-
* <h3 id="cancel">3. Cancellation</h3>
160+
* <h2 id="cancel">3. Cancellation</h2>
161161
*
162162
* <p>
163163
* The DirectoryWalker contains some of the logic required for cancel processing.
@@ -195,7 +195,7 @@
195195
* scenarios.
196196
* </p>
197197
*
198-
* <h4 id="external">3.1 External / Multi-threaded</h4>
198+
* <h3 id="external">3.1 External / Multi-threaded</h3>
199199
*
200200
* <p>
201201
* This example provides a public <code>cancel()</code> method that can be
@@ -228,7 +228,7 @@
228228
* }
229229
* </pre>
230230
*
231-
* <h4 id="internal">3.2 Internal</h4>
231+
* <h3 id="internal">3.2 Internal</h3>
232232
*
233233
* <p>
234234
* This shows an example of how internal cancellation processing could be implemented.

src/main/java/org/apache/commons/io/FileUtils.java

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1309,13 +1309,13 @@ public static void copyDirectory(final File srcDir, final File destDir,
13091309
* it is not guaranteed that those operations will succeed.
13101310
* If the modification operation fails, no indication is provided.
13111311
* </p>
1312-
* <h3>Example: Copy directories only</h3>
1312+
* <h4>Example: Copy directories only</h4>
13131313
* <pre>
13141314
* // only copy the directory structure
13151315
* FileUtils.copyDirectory(srcDir, destDir, DirectoryFileFilter.DIRECTORY);
13161316
* </pre>
13171317
*
1318-
* <h3>Example: Copy directories and txt files</h3>
1318+
* <h4>Example: Copy directories and txt files</h4>
13191319
* <pre>
13201320
* // Create a filter for ".txt" files
13211321
* IOFileFilter txtSuffixFilter = FileFilterUtils.suffixFileFilter(".txt");
@@ -1361,13 +1361,13 @@ public static void copyDirectory(final File srcDir, final File destDir,
13611361
* not guaranteed that those operations will succeed.
13621362
* If the modification operation fails, no indication is provided.
13631363
* </p>
1364-
* <h3>Example: Copy directories only</h3>
1364+
* <h4>Example: Copy directories only</h4>
13651365
* <pre>
13661366
* // only copy the directory structure
13671367
* FileUtils.copyDirectory(srcDir, destDir, DirectoryFileFilter.DIRECTORY, false);
13681368
* </pre>
13691369
*
1370-
* <h3>Example: Copy directories and txt files</h3>
1370+
* <h4>Example: Copy directories and txt files</h4>
13711371
* <pre>
13721372
* // Create a filter for ".txt" files
13731373
* IOFileFilter txtSuffixFilter = FileFilterUtils.suffixFileFilter(".txt");

src/main/java/org/apache/commons/io/comparator/package.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020
<p>This package provides various {@link java.util.Comparator} implementations
2121
for {@link java.io.File}s.
2222
</p>
23-
<h3>Sorting</h3>
23+
<h2>Sorting</h2>
2424
<p>
2525
All the compartors include <i>convenience</i> utility <code>sort(File...)</code> and
2626
<code>sort(List)</code> methods.
@@ -39,7 +39,7 @@ <h3>Sorting</h3>
3939
File[] files = NameFileComparator.NAME_COMPARATOR.sort(dir.listFiles());
4040
</pre>
4141

42-
<h3>Composite Comparator</h3>
42+
<h2>Composite Comparator</h2>
4343
<p>
4444
The <a href="CompositeFileComparator.html">CompositeFileComparator</a> can be used
4545
to compare (and sort lists or arrays of files) by combining a number other comparators.
@@ -57,7 +57,7 @@ <h3>Composite Comparator</h3>
5757
comparator.sort(files);
5858
</pre>
5959

60-
<h3>Singleton Instances (thread-safe)</h3>
60+
<h2>Singleton Instances (thread-safe)</h2>
6161
<p>
6262
The {@link java.util.Comparator} implementations have some <i>convenience</i>
6363
singleton(<i>thread-safe</i>) instances ready to use:

src/main/java/org/apache/commons/io/input/BOMInputStream.java

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@
4343
* </ul>
4444
*
4545
*
46-
* <h3>Example 1 - Detect and exclude a UTF-8 BOM</h3>
46+
* <h2>Example 1 - Detect and exclude a UTF-8 BOM</h2>
4747
*
4848
* <pre>
4949
* BOMInputStream bomIn = new BOMInputStream(in);
@@ -52,7 +52,7 @@
5252
* }
5353
* </pre>
5454
*
55-
* <h3>Example 2 - Detect a UTF-8 BOM (but don't exclude it)</h3>
55+
* <h2>Example 2 - Detect a UTF-8 BOM (but don't exclude it)</h2>
5656
*
5757
* <pre>
5858
* boolean include = true;
@@ -62,7 +62,7 @@
6262
* }
6363
* </pre>
6464
*
65-
* <h3>Example 3 - Detect Multiple BOMs</h3>
65+
* <h2>Example 3 - Detect Multiple BOMs</h2>
6666
*
6767
* <pre>
6868
* BOMInputStream bomIn = new BOMInputStream(in,

src/main/java/org/apache/commons/io/monitor/FileEntry.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@
3030
* <li>Children - contents of a directory (see {@link File#listFiles(java.io.FileFilter)})</li>
3131
* </ul>
3232
*
33-
* <h3>Custom Implementations</h3>
33+
* <h2>Custom Implementations</h2>
3434
* <p>
3535
* If the state of additional {@link File} attributes is required then create a custom
3636
* {@link FileEntry} with properties for those attributes. Override the

0 commit comments

Comments
 (0)