Maven Javadoc Plugin

Owned by 정광섭
Last updated: 2019-Mar-25
2 min read

개요

javadoc 툴을 이용하여 javadocs 를 생성해주는 plugin.


Goals

사용

Project report 에서 javadoc 정의

 <reporting>
    <plugins>
      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-javadoc-plugin</artifactId>
        <version>3.1.0</version>
        <configuration>

        </configuration>
      </plugin>
    </plugins>
  </reporting>

mvn site 실행시 javadoc 도 같이 생성된다.

Build 태그에서 javadoc 정의

설정
<build>
    <plugins>
      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-javadoc-plugin</artifactId>
        <version>3.1.0</version>
        <configuration>
             <show>private</show>
             <nohelp>true</nohelp>
        </configuration>
      </plugin>
    </plugins>
  </build>

다음 goal 로 javadoc 을 생성할 수 있다.

mvn javadoc:javadoc
mvn javadoc:jar
mvn javadoc:aggregate
mvn javadoc:aggregate-jar
mvn javadoc:test-javadoc
mvn javadoc:test-jar
mvn javadoc:test-aggregate
mvn javadoc:test-aggregate-jar

설정

stylesheet 변경

  1. spring javadoc stylesheet 를 참고하여 stylesheet 를 다운받는다.

  2. configuration 에 stylesheet 경로 설정

          <configuration>
          <stylesheetfile>${basedir}/path/to/your/stylesheetfile.css</stylesheetfile>
          ...
      </configuration>

특정 패키지 제외

configuration 에 <excludePackageNames/> 사용
<configuration>
    <excludePackageNames>com.mycompany.myapp.package1.*:com.mycompany.myapp.package2:*.util.*</excludePackageNames>
</configuration>


Javadoc 을 remote 에 upload 하기

Java 8 의 Doclint 중지하기

Java 8 은 Javadoc 에 대해서도 lint 를 수행하므로 잘못된 doc이 있을 경우 warning이 아닌 error로 처리해서 javadoc 생성을 중지한다. 장기적으로는 정확한 javadoc 을 작성하는게 좋겠지만 error 로 인해 생성이 안 될 경우 다음 설정으로 예전처럼 warning으로 처리할 수 있다.

<configuration>
   <doclint>none</doclint>
</configuration>


Ref