2016-09-05 3 views
3

Java 8에서 신성한 JavaDoc lint 기능을 끄는 방법에 대한 많은 정보가 있습니다. 믿거 나 말거나, 오늘은이 기능을 사용하고 JavaDocs를 수정하기로 결정했습니다. 그러나 표준 구성에서 모든 누락 가능성에 대해 불만을 제기하고 있습니다 @param@return. Java 8 javadoc technotes에서 JavaDoc 문서에서 볼 수있는 내 선택의 폭은 -Xdoclint:all,-missing입니다. 여기에는 모든 수표가 포함되어야하지만 누락 된 문서 기회에 대한 불만을 제기하지 마십시오. 도움이되지 않았다 인용하지만,합리적인 doclint 매개 변수를 사용하여 maven JavaDoc 사용

[ERROR] Exit code: 1 - javadoc: error - invalid flag: -missing 

내가 받는다는의 매개 변수 처리가 문제가 있음을 의심 : 나는 오류가

<reporting> 
    <plugins> 
     <plugin> 
     <groupId>org.apache.maven.plugins</groupId> 
     <artifactId>maven-javadoc-plugin</artifactId> 
     <version>2.10.4</version> 
     <configuration> 
      <additionalparam>-Xdoclint:all,-missing</additionalparam> 
      <aggregate>false</aggregate> 
     </configuration> 
     <reportSets> 
      <reportSet> 
      <id>default</id> 
      <reports> 
       <report>javadoc</report> 
      </reports> 
      </reportSet> 
     </reportSets> 
     </plugin> 
    </plugins> 
    </reporting> 

그러나 mvn site으로 실행하는 경우 : 받는다는 구성은 같다.

아이디어를 사용하는 방법은 무엇입니까? 합리적인 방법으로 JavaDoc을 검사하는 좋은 대안이 있습니까?

+0

'-Xdoclint : "all, -missing"'어쩌면 그 중 하나가 언급되었을 것입니다. –

답변

1

올바른 구문은 다음과 같습니다

-Xdoclint:all -Xdoclint:-missing 
+0

Maven에서 작동합니다. 감사합니다! – cruftex

2

당신이 (-Xdoclint:all,-missing)을 작동 할 것으로 예상 구문이 올바른지. 그것은 네이티브 커맨드 라인 javadoc 도구로 잘 동작 할 것입니다. 아쉽게도 Maven JavaDoc Plugin은 쉼표를 사용하면 추가 매개 변수를 여러 매개 변수로 분할하는 것으로 보입니다. 이 버그는 MJAVADOC-368에 설명되어 있습니다.

@hasnae 응답 (-Xdoclint:all -Xdoclint:-missing)에 설명되어있는보다 자세한 구문을 사용하면 문제를 피할 수 있습니다.