Class SeoJavadocFilter

java.lang.Object
com.aoapps.ant.tasks.SeoJavadocFilter

public final class SeoJavadocFilter extends Object
Filters javadocs for search engine optimization. Performs the following transformations:

Note: This task should be performed before ZipTimestampMerge in order to have correct content to be able to maintain timestamps.

  1. Adds Canonical URLs to each page.
  2. Adds <meta name="robots" content="noindex, nofollow"> to selective pages. See getRobotsHeader(java.io.File, org.apache.commons.compress.archivers.zip.ZipArchiveEntry, org.apache.commons.io.function.IOSupplier, java.util.Map, java.lang.Iterable).
  3. rel="nofollow" is added to all links matching the configured nofollow and follow prefixes. This defaults to Java SE, Java EE, and Jakarta EE apidocs.

All existing ZIP entry timestamps are preserved.

This does not have any direct Ant dependencies. If only using this class, it is permissible to exclude the ant dependencies.

See javadoc-cleanup GitHub Action.

Author:
AO Industries, Inc.