如何從javadoc中排除受保護的方法？

Question

如何從javadoc中排除受保護的方法？

我需要記錄一些但不是所有的保護方法。

感謝

Answer 1

您可以排除使用命令行選項"-protected"所有保護的方法，但我只是更緊密地重讀你的問題，並意識到這可能不是你所期待的。

Answer 2

你不能用直的Javadoc做到這一點，但是，這取決於你需要什麼其他的javadoc設施，以及它是如何爲你生成JavaDoc的，你可以考慮切換到Doclava。 Doclava是javadoc的doclet（想法：插件），它確實識別@hide標記。

HTML輸出也更漂亮。

不幸的是它沒有識別大量的javadoc命令行選項，所以它可能不適合。

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

Answer 3

如果您使用的是Maven插件，你可以使用顯示標籤進入配置標籤有值公共，如下圖所示。在這種情況下，只有公共類的成員纔會顯示在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>