JarCasting
JarCasting JarCasting

Doclet to Hide Elements

Doclet that will allow hiding/elements via annotations

License

License

APLv2.0
Categories

Categories

IDE Development Tools
GroupId

GroupId

org.goots.hiderdoclet
ArtifactId

ArtifactId

parent
Last Version

Last Version

1.1
Release Date

Release Date
Type

Type

pom
Description

Description

Doclet to Hide Elements
Doclet that will allow hiding/elements via annotations
Project URL

Project URL

http://github.com/rnc/hiderdoclet
Source Code Management

Source Code Management

http://github.com/rnc/hiderdoclet

Download parent

Filename Size
parent-1.1.pom 5 KB
Browse

How to add to project

<!-- https://jarcasting.com/artifacts/org.goots.hiderdoclet/parent/ -->
<dependency>
    <groupId>org.goots.hiderdoclet</groupId>
    <artifactId>parent</artifactId>
    <version>1.1</version>
    <type>pom</type>
</dependency>
// https://jarcasting.com/artifacts/org.goots.hiderdoclet/parent/
implementation 'org.goots.hiderdoclet:parent:1.1'
// https://jarcasting.com/artifacts/org.goots.hiderdoclet/parent/
implementation ("org.goots.hiderdoclet:parent:1.1")
'org.goots.hiderdoclet:parent:pom:1.1'
<dependency org="org.goots.hiderdoclet" name="parent" rev="1.1">
  <artifact name="parent" type="pom" />
</dependency>
@Grapes(
@Grab(group='org.goots.hiderdoclet', module='parent', version='1.1')
)
libraryDependencies += "org.goots.hiderdoclet" % "parent" % "1.1"
[org.goots.hiderdoclet/parent "1.1"]

Dependencies

There are no dependencies for this project. It is a standalone project that does not depend on any other jars.

Project Modules

  • doclet
  • test

Build Status (Travis CI)

JavaDoc Doclet Extension

This is a JDK11 (and above) doclet that adds the capability to ignore arbitrary code if it has been annotated with @JavadocExclude.

For example, using the code from here:

    /**
     * Don't include me!
     */
    @JavadocExclude
    public void dummyMethod()
    {

    }

Configuration

There is only a single configuration parameter currently: org.goots.hiderdoclet.logLevel. For example to enable debug logging for the doclet pass as an additional option to the doclet configuration:

    <additionalJOption>-J-Dorg.goots.hiderdoclet.logLevel=debug</additionalJOption>

Other supported values are info (the default) and warn. The value is case insensitive.

Exanple

A complete example is

         <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-javadoc-plugin</artifactId>
            <executions>
               <execution>
                  <id>attach-javadocs</id>
                  <configuration>
                     <source>11</source>
                     <doclet>org.goots.hiderdoclet.doclet.JavadocFilter</doclet>
                     <docletArtifact>
                        <groupId>org.goots.hiderdoclet</groupId>
                        <artifactId>doclet</artifactId>
                        <version>1.0</version>
                     </docletArtifact>
                     <additionalJOptions>
                        <additionalJOption>-J--add-exports=jdk.javadoc/jdk.javadoc.internal.tool=ALL-UNNAMED</additionalJOption>
                     </additionalJOptions>
                     <detectJavaApiLink>true</detectJavaApiLink>
                  </configuration>
               </execution>
            </executions>
         </plugin>

Versions

Version
1.1
1.0