From 7979570d39909195e173de05450fb1acf8b3eec5 Mon Sep 17 00:00:00 2001 From: Andreas Dangel Date: Fri, 22 Mar 2024 09:12:17 +0100 Subject: [PATCH] [doc] Create empty class so that javadoc jar is created This needs to be done to fulfill the requirement of maven central, that every artefact has to have a javadoc jar. However, pmd-doc only contains internal classes. --- .../pmd/doc/InternalApiBridge.java | 25 +++++++++++++++++++ .../net/sourceforge/pmd/doc/package-info.java | 8 ++++++ 2 files changed, 33 insertions(+) create mode 100644 pmd-doc/src/main/java/net/sourceforge/pmd/doc/InternalApiBridge.java create mode 100644 pmd-doc/src/main/java/net/sourceforge/pmd/doc/package-info.java diff --git a/pmd-doc/src/main/java/net/sourceforge/pmd/doc/InternalApiBridge.java b/pmd-doc/src/main/java/net/sourceforge/pmd/doc/InternalApiBridge.java new file mode 100644 index 0000000000..58746a417d --- /dev/null +++ b/pmd-doc/src/main/java/net/sourceforge/pmd/doc/InternalApiBridge.java @@ -0,0 +1,25 @@ +/* + * BSD-style license; for more info see http://pmd.sourceforge.net/license.html + */ + +package net.sourceforge.pmd.doc; + +import net.sourceforge.pmd.annotation.InternalApi; + +/** + * Internal API. + * + *

Acts as a bridge between outer parts of PMD and the restricted access + * internal API of this package. + * + *

None of this is published API, and compatibility can be broken anytime! + * Use this only at your own risk. + * + * @apiNote Internal API + */ +@InternalApi +public final class InternalApiBridge { + // note: this is empty - all classes in pmd-doc are internal. + // this class is only here to fulfill the maven central requirement, + // that every artefact has to have a javadoc jar. +} diff --git a/pmd-doc/src/main/java/net/sourceforge/pmd/doc/package-info.java b/pmd-doc/src/main/java/net/sourceforge/pmd/doc/package-info.java new file mode 100644 index 0000000000..3e0ab967f9 --- /dev/null +++ b/pmd-doc/src/main/java/net/sourceforge/pmd/doc/package-info.java @@ -0,0 +1,8 @@ +/* + * BSD-style license; for more info see http://pmd.sourceforge.net/license.html + */ + +/** + * This module contains only internal code to generate the rule documentation pages. + */ +package net.sourceforge.pmd.doc;