-
-
Notifications
You must be signed in to change notification settings - Fork 1.5k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[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.
- Loading branch information
Showing
2 changed files
with
33 additions
and
0 deletions.
There are no files selected for viewing
25 changes: 25 additions & 0 deletions
25
pmd-doc/src/main/java/net/sourceforge/pmd/doc/InternalApiBridge.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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. | ||
* | ||
* <p>Acts as a bridge between outer parts of PMD and the restricted access | ||
* internal API of this package. | ||
* | ||
* <p><b>None of this is published API, and compatibility can be broken anytime!</b> | ||
* 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. | ||
} |
8 changes: 8 additions & 0 deletions
8
pmd-doc/src/main/java/net/sourceforge/pmd/doc/package-info.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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; |