Doclet to Hide Elements

Doclet that will allow hiding/elements via annotations

Лицензия

Лицензия

APLv2.0
Категории

Категории

IDE Инструменты разработки
Группа

Группа

org.goots.hiderdoclet
Идентификатор

Идентификатор

parent
Последняя версия

Последняя версия

1.1
Дата

Дата

Тип

Тип

pom
Описание

Описание

Doclet to Hide Elements
Doclet that will allow hiding/elements via annotations
Ссылка на сайт

Ссылка на сайт

http://github.com/rnc/hiderdoclet
Система контроля версий

Система контроля версий

http://github.com/rnc/hiderdoclet

Скачать parent

Имя Файла Размер
parent-1.1.pom 5 KB
Обзор

Как подключить последнюю версию

<!-- 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"]

Зависимости

Библиотека не имеет зависимостей. Это самодостаточное приложение, которое не зависит ни от каких других библиотек.

Модули Проекта

  • 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>

Версии библиотеки

Версия
1.1
1.0