2013-07-16 1 views
0

javadoc에서 보호 된 메소드를 어떻게 제외합니까?javadoc에서 보호 된 메소드를 어떻게 제외합니까?

일부 보호 방법을 문서화해야하지만 보호되지는 않습니다.

감사

+1

위의 문서에 @hide를 넣으십시오. – njzk2

+0

오 이런 세상에 그런 태그가 있습니다. 그렇다면 왜 인터넷에있는 모든 문서 및 자습서에 그러한 태그가 없다고 말하면 복잡한 것을 작성하여 다른 솔루션을 만들어야합니다. – user2381422

+0

사실, 오류가 발생하지 않습니다. @hide는 알 수없는 태그입니다. – user2381422

답변

0

명령 줄 옵션 "-protected"모든 보호 방법을 제외 할 수 있습니다,하지만 난 그냥 더 밀접하게 질문을 다시 읽고이 당신을 위해 무엇을 찾고있는 아마 깨닫는다.

0

직선의 Javadoc에서는이 작업을 수행 할 수 없지만 필요한 다른 javadoc 기능과 javadoc을 생성하는 방법에 따라 Doclava으로 전환하는 것이 좋습니다. Doclava는 javadoc 용 도크 렛 (think : plug-in)이며 이 @hide 태그를 인식합니까?

HTML 출력도 훨씬 더 예뻐요.

불행히도 은 javadoc 명령 줄 옵션의 큰 부분을 인식하지 않으므로 적합하지 않을 수 있습니다. 당신이 받는다는 플러그인을 사용하는 경우

https://code.google.com/p/doclava/

0

, 당신은 아래 그림과 같이 공공 값 으로 구성 태그에 태그를 표시 할 수 있습니다. 그 경우, 클래스의 public 멤버 만이 javadoc에 표시됩니다.

 <plugin> 
      <groupId>org.apache.maven.plugins</groupId> 
      <artifactId>maven-javadoc-plugin</artifactId> 
      <version>2.10.1</version> 
      <configuration> 
       <show>public</show> 
       <doctitle>My company API</doctitle> 
       <subpackages>my.company.package.api</subpackages> 
      </configuration> 
     </plugin> 
관련 문제